INtime SDK Help
ReceiveRtReply
INtime SDK v6 > About INtime > INtime Kernel > Ports > ReceiveRtReply

From INtime 6.0 the INtime Service and Port objects have been deprecated.

New projects should not be started using these features, and existing projects will not work with XM mode. You will receive a compiler warning by default if you use these calls.

Receives a reply message to an earlier RSVP transmission. The port cannot be a sink port.

LPVOID ReceiveRtReply(

RTHANDLE hPort, // a port handle
WORD wTransID, // the identifier for the request-response transaction
DWORD dwMilliseconds, // the time the caller is prepared to wait for the response
LPRECEIVEINFO lpReplyInfo // a pointer to a RECEIVEINFO structure
);

Parameters

hPort
A handle for the port that is to receive the message.
wTransID
The transaction ID returned from the associated SendRtMessageRSVP function.
dwMilliseconds
Specifies the maximum time a task will wait for a message:
NO_WAIT The thread does not wait.
WAIT_FOREVER The thread waits for its request to be fully satisfied.
1-655349 Calling thread goes to sleep for this many milliseconds, after which it awakes.

Note: The kernel converts milliseconds high-level ticks.

lpReplyInfo
A pointer to a RECEIVEINFO structure where the thread receives information about the message received.

Return Values

A pointer to the data portion of the received message. This may be a contiguous or non-contiguous buffer, as indicated by the flags field of the RECEIVEINFO structure received through lpReplyInfo. A NULL value is valid for a message with no data part.
Success.
A BAD_POINTER value.
Failure. To determine the status, call GetLastRtError.

Status

E_OK 0x0000
No exceptional conditions occurred.
E_TIME 0x0001
The operation timed out before completion.
E_EXIST 0x0006
The port is already being deleted.
E_STATE 0x0008
The port is a sink port with no ports forwarded to it.
E_TRANS_ID 0x00E8
The wTransId parameter is not valid.
E_TYPE 0x8002
The handle supplied is not for a port object.
E_NUC_BAD_BUF 0x80E2
The receive info pointer was invalid.

Requirements

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

See Also

Port system calls, SendRtMessageRSVP, RECEIVEINFO