GetRtLongDataMessage

Requests the data for a long data message previously notified by a return from ReceiveRtDataMessage.

BOOLEAN GetRtLongDataMessage( 
    RTHANDLE hQueue, 
    MSG_DESCRIPTOR *msgDesc, 
    LPVOID msgBuffer, 
    DWORD msgBufferLength, 
    DWORD *msgSize);

Parameters

hQueue: A handle for a valid queue object where the descriptor at msgDesc was received.
msgDesc: A pointer to a MSG_DESCRIPTOR message previously returned from ReceiveRtDataMessage.
msgBuffer: A pointer to a buffer to receive the long data message.
msgBufferLength: The number of bytes in the message buffer.
msgSize: A pointer to a DWORD location which receives the number of bytes actually received by the call.

Remarks

Note that in the current implementation the queue handle hQueue is not used and is not validated. However, you should supply the handle of the queue where the descriptor was received to be compatible with possible future implementations.

Note: In the case where the sending and receiving process are each on a different node, at least one of the processes sender or receiver) must be on the same node as the queue object.

Returns

Returns TRUE on success. Returns FALSE on failure. Call GetLastRtError() to find the failure status. Possible status values include:

E_PARAM	The msgBufferLength parameter is less than the size of the waiting long data message.
E_CANCELLED	The long data message transfer was canceled and is no longer available.
E_BAD_ADDR	The msgBuffer parameter is not valid.

Requirements

Versions	Defined in	Include	Link to
INtime 5.0	intime/rt/include/rtbase.h	rt.h	rt.lib

Structures

MSG_DESCRIPTOR structure