DosPurgeQueue

Purges a queue of all its elements.

Syntax
DosPurgeQueue(hq)

Parameters

 * hq (HQUEUE) - input : The handle of the queue to be purged.

Return Code

 * ulrc (APIRET) - returns:DosPurgeQueue returns one of the following values:
 * 0  NO_ERROR
 * 330 ERROR_QUE_PROC_NOT_OWNED
 * 337 ERROR_QUE_INVALID_HANDLE

Remarks
The server process issues DosPurgeQueue to empty a queue of all its elements. This function is not available to client processes.

Warning: This is an unconditional purge of all elements in the queue.

Related Functions

 * DosCloseQueue
 * DosCreateQueue
 * DosOpenQueue
 * DosPeekQueue
 * DosQueryQueue
 * DosReadQueue
 * DosWriteQueue