Click here to show toolbars of the Web Online Help System: show toolbars |
MIL_ID ContextAppId, | //in |
MIL_ID EventId, | //in |
MIL_INT64 InfoType, | //in |
void *UserVarPtr | //out |
This function retrieves information about the event that caused the hook-handler function to be called. This function should only be called within the scope of an application hook-handler function call (see MappHookFunction()).
Specifies the identifier of the application context to use.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the current application context. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the application context identifier. |
Specifies the application event identifier received by the hook-handler function. See MappHookFunction() for more information.
Specifies the type of information to get.
See the Parameter associations section for possible values that can be specified.
Specifies the address in which to write the requested information. Note that, when getting parameter values (MappGetHookInfo() with M_PARAM_VALUE), the UserVarPtr parameter should be of the same data type as value of the selected parameter.
See the Parameter associations section for possible values that can be returned.
The tables below list possible values for the InfoType parameter and possible values returned to the UserVarPtr parameter.
If the hook-handler function was called due to an M_ERROR_CURRENT or M_ERROR_FATAL event type, the InfoType parameter can be set to one of the values below.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the error code returned by the last function call. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the first error subcode returned by the last function call. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the second error subcode returned by the last function call. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the third error subcode returned by the last function call. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the number of error subcodes associated with the last function called, when it returns an error. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
If the hook-handler function was called due to an M_ERROR_GLOBAL event type, the InfoType parameter can be set to one of the values below.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the error code of the first error that has occurred since the last call to MappGetError() (with ErrorType set to M_GLOBAL). |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the opcode associated with the first error-generating function since the last call to MappGetError() (with ErrorType set to M_GLOBAL). |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the first error subcode of the first error that has occurred since the call to MappGetError() (with ErrorType set to M_GLOBAL). |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the second error subcode of the first error that has occurred since the call to MappGetError() (with ErrorType set to M_GLOBAL). |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the third error subcode of the first error that has occurred since the call to MappGetError() (with ErrorType set to M_GLOBAL). |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the number of error subcodes associated with the first error that occurred since the last call to MappGetError() (with ErrorType set to M_GLOBAL). |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
If the hook-handler function was called due to an M_ERROR_CURRENT, M_TRACE_START, or M_TRACE_END event type, the InfoType parameter can be set to the value below.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the opcode associated with the last function called when it returns an error (for M_ERROR_CURRENT), just started (for M_TRACE_START), or just ended (for M_TRACE_END). |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
You can add the following value to the above-mentioned values to get the associated message instead of the numeric code.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Returns the error message instead of the error code, or the function name instead of the function code. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_TEXT_CHAR
(more
details...)
|
You can add the following value to the above-mentioned value to get the message's length.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the length of the string, including the terminating null character ("\0"). |
If the hook-handler function was called due to an M_OBJECT_PUBLISH_DMIL event type, the InfoType parameter can be set to the value below.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the MIL identifier of the object whose publication state was modified. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
If the hook-handler function was called due to an M_TRACE_START or M_TRACE_END event type, the InfoType parameter can be set to one of the values below.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the number of parameters associated with the MIL function called. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the size, in bytes, of the specified parameter. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the data type of the specified parameter of the MIL function called. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_DOUBLE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_FLOAT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_ID. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_INT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_INT8. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_INT16. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_INT32. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_INT64. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_UINT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_UINT8. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_UINT16. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_UINT32. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is an array of type MIL_UINT64. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_DOUBLE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_FLOAT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_ID. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_INT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_INT8. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_INT16. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_INT32. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_INT64. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_UINT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_UINT8. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_UINT16. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_UINT32. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant array of type MIL_UINT64. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant data pointer. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant of type MIL_TEXT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant of type MIL_TEXT_ASCII. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a constant of type MIL_TEXT_UNICODE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is a data pointer. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type FILENAME. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type FILENAME_ASCII. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type FILENAME_UNICODE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_DOUBLE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_FLOAT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_ID. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_INT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_INT8. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_INT16. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_INT32. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_INT64. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_TEXT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_TEXT_ASCII. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_TEXT_UNICODE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_UINT. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_UINT8. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_UINT16. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_UINT32. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the parameter is of type MIL_UINT64. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the value of the specified parameter of the MIL function called. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info:
Data type: address of a
MIL_DOUBLE | address of a MIL_ID
| address of a MIL_INT32 | address of
a MIL_INT64 | address of a
MIL_TEXT_PTR | address of a
void (more
details...)
|
You must add the following value to the above-mentioned values to determine the number of the parameter for which to receive the information.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the number of the parameter for which to retrieve the information. |
Header | Include mil.h. |
Library | Use mil.lib. |
DLL | Requires mil.dll. |