MobjMessageRead

Filters
See also

User Guide:

Message mailboxes

Reference:

MobjAlloc

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

None.

Function Map

- MessageId

- StatusPtr

Table:

For specifying the status of the operation

- OperationFlag

Table:

For specifying the operation

Return value

Compilation information

Synopsis

Reads data from a message sent to the message mailbox.

Syntax

MIL_INT64 MobjMessageRead(

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

)

Description

This function reads the data from a message sent to the message mailbox.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.

Parameters

This function is not supported on the selected boards.

Parameters

MessageId

Specifies the identifier of the message mailbox.

MessagePtr

Accepts the following address:

Data type: array of type 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.

MessageInSize

Specifies the size of the message, in Bytes. You must set this value to 0 if MessagePtr is set to M_NULL.

MessageOutSizePtr

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.

MessageTagPtr

Specifies the address of the variable in which the message tag associated with the message will be written. If unused, set to M_NULL.

StatusPtr

Specifies the address of the variable in which the status of the read operation will be written. An error will be generated if this parameter is set to M_NULL.

For specifying the status of the operation
Value	Description
M_BUFFER_TOO_SMALL	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...)
M_READ_TIMEOUT	Specifies the read timeout has been attained. The returned message length will be 0. (summarize) Specifies the read timeout has been attained. (more details...)
M_SUCCESS	Specifies the message is copied to MessagePtr.

OperationFlag

Specifies additional options for the read operation.

For specifying the operation
Value	Description
M_DEFAULT	Specifies the default behavior.
M_KEEP_IN_QUEUE	Specifies that if the mailbox is of type M_QUEUE, the message will not be deleted after the read operation.
M_NO_TIMEOUT	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...)
M_REMOVE	Specifies to remove the current message without reading it.

Return value

The returned value is the same as the value written in MessageOutSizePtr.

Compilation information

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll.