DosPurgeQueue (OS/2 1.x): Difference between revisions

Latest revision as of 23:24, 25 January 2020

This call purges a queue of all elements.

Syntax

DosPurgeQueue (QueueHandle)

Parameters

QueueHandle (HQUEUE) - input: Handle of the queue to purge.

Return Code

rc (USHORT) - return: Return code descriptions are:

0 NO_ERROR
330 ERROR_QUE_PROC_NOT_OWNED
337 ERROR_QUE_INVALID_HANDLE

Remarks

A process that creates a queue with DosCreateQueue owns it. Only the owning process and any threads it creates can issue DosPurgeQueue to remove all the elements from the queue.

Bindings

C

#define INCL_DOSQUEUES

USHORT  rc = DosPurgeQueue(QueueHandle);

HQUEUE  QueueHandle;   /* Queue handle */
USHORT  rc;            /* return code */

MASM

EXTRN  DosPurgeQueue:FAR
INCL_DOSQUEUES      EQU 1

PUSH   WORD    QueueHandle   ;Queue handle
CALL   DosPurgeQueue

Returns WORD

@@ Line 8: / Line 8: @@
 ==Return Code==
- rc (USHORT) - return
+;rc (USHORT) - return:Return code descriptions are:
-Return code descriptions are:
+*0 NO_ERROR
-* 0          NO_ERROR
+*330 ERROR_QUE_PROC_NOT_OWNED
-* 330        ERROR_QUE_PROC_NOT_OWNED
+*337 ERROR_QUE_INVALID_HANDLE
-* 337        ERROR_QUE_INVALID_HANDLE
 ==Remarks==
 A process that creates a queue with [[DosCreateQueue (OS/2 1.x)|DosCreateQueue]] owns it. Only the owning process and any threads it creates can issue DosPurgeQueue to remove all the elements from the queue.
-===C Binding===
+==Bindings==
+===C===
 <PRE>
 #define INCL_DOSQUEUES
@@ Line 23: / Line 23: @@
 USHORT  rc = DosPurgeQueue(QueueHandle);
-HQUEUE           QueueHandle;   /* Queue handle */
+HQUEUE  QueueHandle;   /* Queue handle */
+USHORT  rc;            /* return code */
-USHORT           rc;            /* return code */
 </PRE>
-===MASM Binding===
+===MASM===
 <PRE>
 EXTRN  DosPurgeQueue:FAR
@@ Line 39: / Line 38: @@
 </PRE>
-[[Category:Dos]]
+[[Category:Dos16]]