INtime SDK Help
ntxGetRtLongDataMessage
INtime SDK v7 > About INtime > INtime Kernel > Message Queues > ntxGetRtLongDataMessage

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

BOOLEAN ntxGetRtLongDataMessage( 
NTXHANDLE hQueue,
MSG_DESCRIPTOR *msgDesc,
LPVOID msgBuffer,
DWORD msgBufferLength,
DWORD *msgSize);

Parameters

hQueue 
A handle for a valid queue object.
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.

Returns

Returns TRUE on success. Returns FALSE on failure. Call GetLastRtError() to find the failure status. Possible status values include:
E_EXIST The hQueue parameter does not refer to an existing object
E_TYPE The hQueue parameter does not refer to a valid queue object.
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/nt/include/ntx.h ntx.h ntx.lib, ntxext.lib
See Also

Structures

Message Queues