Receives handles from an object mailbox. Automatically converts the RTHANDLE to an NTXHANDLE.

NTXHANDLE ntxReceiveRtHandle(
    NTXHANDLE hMailbox,
    DWORD dwMilliseconds,
    NTXHANDLE *phResponse
);

Parameters

hMailbox

RT Object mailbox to get the object from.

dwMilliseconds

The number of milliseconds the calling thread waits:

NO_WAIT	The thread does not wait.
INFINITE	The thread waits for its request to be fully satisfied.
Any positive integer	Calling thread goes to sleep for this many milliseconds, after which it awakes. Note: The kernel converts milliseconds to high-level ticks.

phResponse

Pointer to where the handle to the response object is returned. If NULL, the response object handle (if any) is discarded.

Return Values

The handle received from the object mailbox.

Success

NTX_BAD_NTXHANDLE

To determine the status, call ntxGetLastRtError

Status

E_OK 0x0000

No exceptional conditions occurred.

E_TIME 0x0001

An object is not available within the specified time limit. One of these is true:

• The calling thread could not wait and there a handle was not available.
• The thread waited in the thread queue and the waiting period specified in dwMilliseconds elapsed before the thread got the desired handle.

E_EXIST 0x0006

hMailbox is not a handle for an existing object.

E_TYPE 0x8002

hMailbox is not an object mailbox.

E_NTX_INTERNAL_ERROR 0x1001

The DLL could not contact the RT kernel to complete the request.

Requirements

See Also

Mailbox system calls, high-level ticks