DosPurgeQueue (OS/2 1.x): Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 9: | Line 9: | ||
==Return Code== | ==Return Code== | ||
;rc (USHORT) - return:Return code descriptions are: | ;rc (USHORT) - return: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 | ||
| Line 16: | Line 16: | ||
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. | 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 | ==Bindings== | ||
===C=== | |||
<PRE> | <PRE> | ||
#define INCL_DOSQUEUES | #define INCL_DOSQUEUES | ||
| Line 26: | Line 27: | ||
</PRE> | </PRE> | ||
===MASM | ===MASM=== | ||
<PRE> | <PRE> | ||
EXTRN DosPurgeQueue:FAR | EXTRN DosPurgeQueue:FAR | ||
| Line 37: | Line 38: | ||
</PRE> | </PRE> | ||
[[Category: | [[Category:Dos16]] | ||
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