Receives handles from an object mailbox.

Visual Basic:

Function ntxReceiveRtHandle(
  ByVal hMailbox As Integer,
  ByVal dwMilliseconds As Integer)
As Integer
Function ntxReceiveRtHandle(
  ByVal hMailbox As Integer,
  ByVal dwMilliseconds As Integer,
  ByRef phResponse As Integer)
As Integer

Visual C#:

Int32 ntxReceiveRtHandle (
  Int32 hMailbox,
  Int32 dwMilliseconds,
  ref Int32 phResponse );
Int32 ntxReceiveRtHandle (
  Int32 hMailbox,
  Int32 dwMilliseconds );

Parameters

hMailbox

RT Object mailbox to get the object from.

dwMilliseconds

The number of milliseconds the calling thread waits:

NTX_NO_WAIT	The thread does not wait.
NTX_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

Variable that receives the handle to the response object. If this parameter is not provided, a possible response object handle is discarded.

Return Values

The handle received from the object mailbox.

Status

E_TIME

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

• The calling thread could not wait and 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

hMailbox is not a handle for an existing object.

E_TYPE

hMailbox is not an object mailbox.

E_NTX_INTERNAL_ERROR

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

Requirements

See Also

INtimeDotNet system calls, Mailbox system calls, high-level ticks