INtime SDK Help
ntxCreateRtMailbox(INtimeDotNet)
INtime SDK v7.1 > About INtime > Alternate APIs > INtimeDotNet > ntxCreateRtMailbox(INtimeDotNet)

Creates an RT mailbox.

Visual Basic:

Function ntxCreateRtMailbox(
  ByVal hLocation As Integer,
  ByVal dwFlags As Integer)
As Integer

Visual C#:

Int32 ntxCreateRtMailbox (
  Int32 hLocation,
  Int32 dwFlags );

Parameters

hLocation
The location handle of the Client Node on which the mailbox will be created.
dwFlags
Specifies flags that control creation of the mailbox. Possible values are described below. Values may be combined where appropriate.
NTX_OBJECT_MAILBOX The mailbox will pass RT object handles. It is mutually exclusive with the NTX_DATA_MAILBOX flag. The mailbox depth may be specified by the MAILBOX_DEPTH(n) macro.
NTX_DATA_MAILBOX The mailbox will pass up to 128-byte messages. In this case, the mailbox depth is initially three messages.
NTX_FIFO_QUEUING Threads will queue in First-In-First-Out order on this object.
NTX_PRIORITY_QUEUING Threads will queue in priority order on this object.
(Chose one)
NTX_DEPTH_8
NTX_DEPTH_12
NTX_DEPTH_16
NTX_DEPTH_20
NTX_DEPTH_24
NTX_DEPTH_28
NTX_DEPTH_32
NTX_DEPTH_36
NTX_DEPTH_40
NTX_DEPTH_44
NTX_DEPTH_48
NTX_DEPTH_52
NTX_DEPTH_56
NTX_DEPTH_60
NTX_DEPTH_64
Determines the number of objects that can queue in an object mailbox. It is ignored for data mailboxes.

Return Values

A handle for the mailbox object just created.

INtimeException Status

E_MEM
Creating a mailbox requires more available memory than the proxy has available.
E_LIMIT
The proxy thread's process reached its object limit.
E_SLOT
You cannot create more RT objects because the GDT's slots are full.

Requirements

Versions Reference
INtime 3.0 INtimeDotNet

See Also

INtimeDotNet system calls, Mailbox system calls