MIL_ID MessageId, | //in |
void *MessagePtr, | //out |
MIL_INT64 MessageInSize, | //in |
MIL_INT64 *MessageOutSizePtr, | //out |
MIL_INT64 *MessageTagPtr, | //out |
MIL_INT64 *StatusPtr, | //out |
MIL_INT64 OperationFlag | //in |
This function reads the data from a message sent to the message mailbox.
Data type: array of type
MIL_UINT8 [optionally, in C++: a reference to a std::vector<MIL_UINT8>
]
Required array size:(MessageInSize)
Specifies the address of the variable in which the message is to be written. If M_NULL is specified, this function will return the length of the message.
Specifies the size of the array pointed to by MessagePtr, in bytes. You must set this value to 0 if MessagePtr is set to M_NULL.
When using a standard vector (std::vector) overload function in C++, you can pass M_DEFAULT to this parameter and MIL will automatically determine the size based on the number of items in the vector passed to the parameter.
Specifies the address of the variable in which the size of the message to be read will be written. If unused, set to M_NULL.
Specifies the address of the variable in which the message tag associated with the message will be written. If unused, set to M_NULL.
Specifies the address of the variable in which the status of the read operation will be written.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the current message is not copied or deleted. The returned message length will be the required length in bytes. (summarize)Specifies the current message is not copied or deleted. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the read timeout has been attained. The returned message length will be 0. (summarize)Specifies the read timeout has been attained. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the message is copied to MessagePtr. |
Specifies additional options for the read operation.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the default behavior. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies that if the mailbox is of type M_QUEUE, the message will not be deleted after the read operation. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to not use the read operation timeout. This will return a status of M_SUCCESS and return 0 if no messages are ready to be read. (summarize)Specifies to not use the read operation timeout. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to remove the current message without reading it. |
Header | Include mil.h. |
Library | Use mil.lib. |
DLL | Requires mil.dll. |