INtime SDK Help
CancelRtLongDataMessage
INtime SDK v7.1 > About INtime > INtime Kernel > Message Queues > CancelRtLongDataMessage

Cancel the receipt of a long data message.

BOOLEAN CancelLongRtDataMessage( 
RTHANDLE hQueue,
MSG_DESCRIPTOR *msgDesc);

Parameters

hQueue
A handle for a valid queue object.
msgDesc
A pointer to a MSG_DESCRIPTOR message returned from a call to ReceiveRtDataMessage.

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_BAD_ADDR The msgDesc parameter is not valid.

Requirements

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