Creates an mailbox.
NTXHANDLE ntxCreateRtMailbox(
NTXLOCATION hLocation,
DWORD 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 |
This flag indicates that the mailbox is to be created to pass RT object handles. It is mutually exclusive with the NTX_DATA_MAILBOX flag. The depth of the mailbox may be specified by the MAILBOX_DEPTH(n) macro. |
NTX_DATA_MAILBOX |
This flag indicates that the mailbox is to be created to pass up to 128-byte messages. In this case the depth of the mailbox is initially 3 messages. |
NTX_FIFO_QUEUING |
This flag indicates that threads will be queued in First-In-First-Out order on this object. |
NTX_PRIORITY_QUEUING |
This flag indicates that threads will be queued in priority order on this object. |
MAILBOX_DEPTH(n) |
This macro determines the number of objects which can be queued in an object mailbox. It is ignored for data mailboxes. The value n must be at least 8, at most 64, and a multiple of 4. |
Return Values
- A handle for the mailbox object just created.
- Success
NTX_BAD_NTXHANDLE
- To determine the status, call ntxGetLastRtError
Status
E_OK 0x0000
- No exceptional conditions occurred.
E_MEM 0x0002
- Creating a mailbox requires more available memory than the proxy has available.
E_LIMIT 0x0004
- The proxy thread's process reached its object limit.
E_STATE 0x0007
- the location is a not running node.
- E_SLOT 0x000C
- You cannot create more RT objects because the 's slots are full.
E_LOCATION 0x8f02
- Invalid NTXLOCATION value was specified.
Requirements
Versions |
Defined in |
Include |
Link to |
INtime 3.0 |
intime/nt/include/ntx.h |
ntx.h |
ntx.lib ntxext.lib |
INtime 4.01 (64-bit Windows) |
intime/nt/include/ntx.h |
ntx.h |
ntx64.lib ntxext64.lib (for 64-bit Windows) |
See Also
Mailbox system calls