Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Function Group►  ◄Overview►                          ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_DOSQUEUES
 
USHORT DosPurgeQueue(hqueue)
HQUEUE hqueue;    /* handle of queue to be purged */
 
The DosPurgeQueue function purges a queue of all elements.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hqueue     Identifies the queue to be purged. This handle must have been
           created previously by using the DosCreateQueue function.
 
Return Value
 
The return value is zero if the function is successful. Otherwise, it is an
error value, which may be one of the following:
 
     ERROR_QUE_INVALID_HANDLE
     ERROR_QUE_PROC_NOT_OWNED
 
Comments
 
Only the process that created the queue may call the DosPurgeQueue
function.
 
See Also
 
DosCreateQueue
 
                                      ♦