INtime SDK Help
DeleteRtMailbox
INtime SDK v7 > About INtime > INtime Kernel > Mailboxes > DeleteRtMailbox

Deletes the mailbox specified by the handle given.

BOOLEAN DeleteRtMailbox(
    RTHANDLE hMailbox    // handle for mailbox to be deleted
);

Parameters

hMailbox
Handle for the mailbox to be deleted.

Remarks

If any threads are queued at the mailbox at deletion time, they are awakened with an E_EXIST exceptional condition. If there is a queue of object handles or data messages, the queue is discarded. Deleting the mailbox counts toward the object limit for the containing process.

Return Values

TRUE
Success
FALSE
To determine the status, call GetLastRtError

Status

E_OK 0x0000
No exceptional conditions occurred.
E_EXIST 0x0006
One of these conditions exist:
  • hMailbox contains an invalid handle.
  • hMailbox represents a mailbox for a process being deleted.
E_TYPE 0x8002
hMailbox requires an RT handle for a mailbox.
E_INVALID_ADDRESS 0x00E2
The address provided for the remote object is not a valid address.

Requirements

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

See Also

Mailbox system calls