DosDeleteMailslot or Dos32DeleteMailslot

The DosDeleteMailslot API deletes a mailslot. This discards all messages, including any that have not been read.

Mailslots enable applications to create and store messages while a program is running. Generally, these mailslots are deleted as the last step in running a program.

Restrictions

This API can be called from DLS and OS/2 workstations. A call to this API must be issued locally. A mailslot can be deleted only by the application that created it.
Syntax

#include <netcons.h>
#include <mailslot.h>
 
DosDeleteMailslot(mailslothandle);     /* 16 bit */
 
Dos32DeleteMailslot(mailslothandle);     /* 32 bit */

Parameters

mailslothandle

(unsigned long) specifies (by its handle) the mailslot to delete.
Return Codes

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) ┌─────────────────────────────┬──────────┬─────────────────────────────────────┐│SYMBOLICCONSTANT │VALUE │MEANING │
├─────────────────────────────┼──────────┼─────────────────────────────────────┤
│ NERR_Success │ 0 │ No errors were encountered. │
├─────────────────────────────┼──────────┼─────────────────────────────────────┤
│ ERROR_INVALID_HANDLE │ 6 │ The specified handle is not valid. │
└─────────────────────────────┴──────────┴─────────────────────────────────────┘


Related Information

For information about:

• Creating a mailslot, see Mailslot - DosMakeMailslot.

• Obtaining information about the status of a mailslot, see Mailslot - DosMailslotInfo.

---

[Back: Mailslot Category]
[Next: DosMailslotInfo or Dos32MailslotInfo]