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.
For specifying the application context
|
|||||||||||||||||||||||||||||||||||||||
Value | Description | ||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Specifies the current application context. |
||||||||||||||||||||||||||||||||||||||
Application Context Identifier |
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.
For retrieving information about an M_ERROR_CURRENT
or M_ERROR_FATAL event type
|
|||||||||||||||||||||||||||||||||||||||
InfoType | Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_CURRENT + |
Retrieves the error code returned by the last function call. The current-error code is reset to M_NULL_ERROR before each MIL function call and is set to a specific error code if an error occurs while trying to execute the function. (summarize)Retrieves the error code returned by the last function call. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_CURRENT_SUB_1 + |
Retrieves the first error subcode returned by the last function call. Note, when there is no error, the error subcode is set to M_NULL_ERROR. (summarize)Retrieves the first error subcode returned by the last function call. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_CURRENT_SUB_2 + |
Retrieves the second error subcode returned by the last function call. Note, when there is no error, the error subcode is set to M_NULL_ERROR. (summarize)Retrieves the second error subcode returned by the last function call. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_CURRENT_SUB_3 + |
Retrieves the third error subcode returned by the last function call. Note, when there is no error, the error subcode is set to M_NULL_ERROR. (summarize)Retrieves the third error subcode returned by the last function call. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_CURRENT_SUB_NB |
Retrieves the number of error subcodes associated with the last function called, when it returns an error. (summarize)Retrieves the number of error subcodes associated with the last function called, when it returns an error. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
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.
For retrieving information about an M_ERROR_GLOBAL
event type)
|
|||||||||||||||||||||||||||||||||||||||
InfoType | Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_GLOBAL + |
Retrieves the error code of the first error that has occurred since the last call to MappGetError() (with ErrorType set to M_GLOBAL). This value is reset to M_NULL_ERROR after each MappGetError() call with this setting. (summarize)Retrieves the error code of the first error that has occurred since the last call to MappGetError() (with ErrorType set to M_GLOBAL). (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_GLOBAL_FCT + |
Retrieves the opcode associated with the first error-generating function since the last call to MappGetError() (with ErrorType set to M_GLOBAL). (summarize)Retrieves the opcode associated with the first error-generating function since the last call to MappGetError() (with ErrorType set to M_GLOBAL). (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_GLOBAL_SUB_1 + |
Retrieves the first error subcode of the first error that has occurred since the call to MappGetError() (with ErrorType set to M_GLOBAL). Note, when there is no error, the error subcode is set to M_NULL_ERROR. (summarize)Retrieves the first error subcode of the first error that has occurred since the call to MappGetError() (with ErrorType set to M_GLOBAL). (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_GLOBAL_SUB_2 + |
Retrieves the second error subcode of the first error that has occurred since the call to MappGetError() (with ErrorType set to M_GLOBAL). Note, when there is no error, the error subcode is set to M_NULL_ERROR. (summarize)Retrieves the second error subcode of the first error that has occurred since the call to MappGetError() (with ErrorType set to M_GLOBAL). (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_GLOBAL_SUB_3 + |
Retrieves the third error subcode of the first error that has occurred since the call to MappGetError() (with ErrorType set to M_GLOBAL). Note, when there is no error, the error subcode is set to M_NULL_ERROR. (summarize)Retrieves the third error subcode of the first error that has occurred since the call to MappGetError() (with ErrorType set to M_GLOBAL). (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_GLOBAL_SUB_NB |
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). (summarize)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). (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
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.
For retrieving information about an M_ERROR_CURRENT,
M_TRACE_START, or M_TRACE_END event type
|
|||||||||||||||||||||||||||||||||||||||
InfoType | Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_CURRENT_FCT + |
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). (summarize)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). (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
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.
For getting the associated message instead of the
numeric code
|
|||||||||||||||||||||||||||||||||||||||
InfoType | Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_MESSAGE + |
Returns the error message instead of the error code, or the function name instead of the function code. (summarize)Returns the error message instead of the error code, or the function name instead of the function code. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
|
You can add the following value to the above-mentioned value to get the message's length.
For getting the message size
|
|||||||||||||||||||||||||||||||||||||||
InfoType | Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_STRING_SIZE |
Retrieves the length of the string, including the terminating null character ("\0"). (summarize)Retrieves the length of the string, including the terminating null character ("\0"). (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
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.
For retrieving information about an
M_OBJECT_PUBLISH_DMIL event type
|
|||||||||||||||||||||||||||||||||||||||
InfoType | Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_OBJECT_ID |
Retrieves the MIL identifier of the object whose publication state was modified. (summarize)Retrieves the MIL identifier of the object whose publication state was modified. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
If the hook-handler function was called due to an M_WEB_CLIENT_CONNECTED or M_WEB_CLIENT_DISCONNECTED event type, the InfoType parameter can be set to the value below.
For retrieving information about an
M_WEB_CLIENT_CONNECTED or M_WEB_CLIENT_DISCONNECTED event
type
|
|||||||||||||||||||||||||||||||||||||||
InfoType | Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_WEB_CLIENT_INDEX |
Retrieves the index that uniquely identifies the instance of your MILweb client application that connected or disconnected. This index refers to the same instance of the MILweb client application, as long as that instance is connected. If the instance disconnects and then reconnects, it is assigned a new index. Indexes of MILweb clients are not zero- or one-based, nor are they guaranteed to be sequential. (summarize)Retrieves the index that uniquely identifies the instance of your MILweb client application that connected or disconnected. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
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.
For retrieving information about an M_TRACE_START or
M_TRACE_END event type
|
|||||||||||||||||||||||||||||||||||||||
|
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_PARAM_NB |
Retrieves the number of parameters associated with the MIL function called. (summarize)Retrieves the number of parameters associated with the MIL function called. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_PARAM_SIZE + |
Retrieves the size, in bytes, of the specified parameter. For an array parameter, the size is: Number of items in the array X Size of the item. You must specify a combination value from the following table: Retrieves the size, in bytes, of the specified parameter. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_INFO + |
Retrieves the data type of the specified parameter of the MIL function called. You must specify a combination value from the following table: Retrieves the data type of the specified parameter of the MIL function called. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
Data type info: Data
type: address of a MIL_INT
Data type info: Data
type: address of a MIL_INT
|
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_DOUBLE |
Specifies that the parameter is an array of type MIL_DOUBLE. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_DOUBLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_FLOAT |
Specifies that the parameter is an array of type MIL_FLOAT. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_FLOAT. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_ID |
Specifies that the parameter is an array of type MIL_ID. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_ID. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_INT |
Specifies that the parameter is an array of type MIL_INT. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_INT. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_INT8 |
Specifies that the parameter is an array of type MIL_INT8. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_INT8. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_INT16 |
Specifies that the parameter is an array of type MIL_INT16. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_INT16. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_INT32 |
Specifies that the parameter is an array of type MIL_INT32. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_INT32. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_INT64 |
Specifies that the parameter is an array of type MIL_INT64. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_INT64. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_UINT |
Specifies that the parameter is an array of type MIL_UINT. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_UINT. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_UINT8 |
Specifies that the parameter is an array of type MIL_UINT8. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_UINT8. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_UINT16 |
Specifies that the parameter is an array of type MIL_UINT16. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_UINT16. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_UINT32 |
Specifies that the parameter is an array of type MIL_UINT32. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_UINT32. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_ARRAY_MIL_UINT64 |
Specifies that the parameter is an array of type MIL_UINT64. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is an array of type MIL_UINT64. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_DOUBLE |
Specifies that the parameter is a constant array of type MIL_DOUBLE. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_DOUBLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_FLOAT |
Specifies that the parameter is a constant array of type MIL_FLOAT. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_FLOAT. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_ID |
Specifies that the parameter is a constant array of type MIL_ID. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_ID. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_INT |
Specifies that the parameter is a constant array of type MIL_INT. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_INT. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_INT8 |
Specifies that the parameter is a constant array of type MIL_INT8. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_INT8. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_INT16 |
Specifies that the parameter is a constant array of type MIL_INT16. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_INT16. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_INT32 |
Specifies that the parameter is a constant array of type MIL_INT32. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_INT32. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_INT64 |
Specifies that the parameter is a constant array of type MIL_INT64. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_INT64. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_UINT |
Specifies that the parameter is a constant array of type MIL_UINT. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_UINT. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_UINT8 |
Specifies that the parameter is a constant array of type MIL_UINT8. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_UINT8. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_UINT16 |
Specifies that the parameter is a constant array of type MIL_UINT16. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_UINT16. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_UINT32 |
Specifies that the parameter is a constant array of type MIL_UINT32. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_UINT32. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_ARRAY_MIL_UINT64 |
Specifies that the parameter is a constant array of type MIL_UINT64. Note that the pointer to the data stored in the array is unavailable after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant array of type MIL_UINT64. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_DATA_PTR |
Specifies that the parameter is a constant data pointer. Note that the pointer to the data is invalid after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a constant data pointer. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_MIL_TEXT |
Specifies that the parameter is a constant of type MIL_TEXT. This implies that the character encoding scheme of the MIL_TEXT parameter is the scheme you are currently using. (summarize)Specifies that the parameter is a constant of type MIL_TEXT. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_MIL_TEXT_ASCII |
Specifies that the parameter is a constant of type MIL_TEXT_ASCII. This only appears when you are currently using a character encoding scheme other than ASCII, and the parameter you are inquiring is specifically in ASCII. (summarize)Specifies that the parameter is a constant of type MIL_TEXT_ASCII. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_CONST_MIL_TEXT_UNICODE |
Specifies that the parameter is a constant of type MIL_TEXT_UNICODE. This only appears when you are currently using a character encoding scheme other than unicode, and the parameter you are inquiring is specifically in unicode. (summarize)Specifies that the parameter is a constant of type MIL_TEXT_UNICODE. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_DATA_PTR |
Specifies that the parameter is a data pointer. Note that the pointer to the data is invalid after exiting the hook-handler function. For future use, copy and save the data. (summarize)Specifies that the parameter is a data pointer. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_FILENAME |
Specifies that the parameter is of type FILENAME. This implies that the character encoding scheme of the FILENAME parameter is the scheme you are currently using. (summarize)Specifies that the parameter is of type FILENAME. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_FILENAME_ASCII |
Specifies that the parameter is of type FILENAME_ASCII. This only appears when you are currently using a character encoding scheme other than ASCII, and the parameter you are inquiring is specifically in ASCII. (summarize)Specifies that the parameter is of type FILENAME_ASCII. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_FILENAME_UNICODE |
Specifies that the parameter is of type FILENAME_UNICODE. This only appears when you are currently using a character encoding scheme other than unicode, and the parameter you are inquiring is specifically in unicode. (summarize)Specifies that the parameter is of type FILENAME_UNICODE. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_DOUBLE |
Specifies that the parameter is of type MIL_DOUBLE. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_FLOAT |
Specifies that the parameter is of type MIL_FLOAT. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_ID |
Specifies that the parameter is of type MIL_ID. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_INT |
Specifies that the parameter is of type MIL_INT. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_INT8 |
Specifies that the parameter is of type MIL_INT8. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_INT16 |
Specifies that the parameter is of type MIL_INT16. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_INT32 |
Specifies that the parameter is of type MIL_INT32. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_INT64 |
Specifies that the parameter is of type MIL_INT64. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_TEXT |
Specifies that the parameter is of type MIL_TEXT. This implies that the character encoding scheme of the MIL_TEXT parameter is the scheme you are currently using. (summarize)Specifies that the parameter is of type MIL_TEXT. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_TEXT_ASCII |
Specifies that the parameter is of type MIL_TEXT_ASCII. This only appears when you are currently using a character encoding scheme other than ASCII, and the parameter you are inquiring is specifically in ASCII. (summarize)Specifies that the parameter is of type MIL_TEXT_ASCII. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_TEXT_UNICODE |
Specifies that the parameter is of type MIL_TEXT_UNICODE. This only appears when you are currently using a character encoding scheme other than unicode, and the parameter you are inquiring is specifically in unicode. (summarize)Specifies that the parameter is of type MIL_TEXT_UNICODE. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_UINT |
Specifies that the parameter is of type MIL_UINT. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_UINT8 |
Specifies that the parameter is of type MIL_UINT8. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_UINT16 |
Specifies that the parameter is of type MIL_UINT16. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_UINT32 |
Specifies that the parameter is of type MIL_UINT32. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_TYPE_MIL_UINT64 |
Specifies that the parameter is of type MIL_UINT64. |
||||||||||||||||||||||||||||||||||||||
M_PARAM_VALUE + |
Retrieves the value of the specified parameter of the MIL function called. You must specify a combination value from the following table: Retrieves the value of the specified parameter of the MIL function called. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr extra info |
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 [optionally, in C++: MIL_STRING ]
| address of a void
MORE
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 [optionally, in C++: MIL_STRING ]
| address of a void
MORE
|
You must add the following value to the above-mentioned values to determine the number of the parameter for which to receive the information.
For specifying the parameter
|
|||||||||||||||||||||||||||||||||||||||
Combination value | Description | ||||||||||||||||||||||||||||||||||||||
1 <= Value <= 16 |
Specifies the number of the parameter for which to retrieve the information. This value must be a positive integer, and should not exceed the number of parameters associated with the MIL function call (M_PARAM_NB). (summarize)Specifies the number of the parameter for which to retrieve the information. (more details...) |
Header | Include mil.h. |
Library | Use mil.lib. |
DLL | Requires mil.dll. |