DosPurgeQueue (OS/2 1.x): Difference between revisions
Created page with "==Description== This call purges a queue of all elements. ==Syntax== <PRE> DosPurgeQueue (QueueHandle) </PRE> ==Parameters== ; QueueHandle (HQUEUE) - input : Handle of..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This call purges a queue of all elements. | This call purges a queue of all elements. | ||
==Syntax== | ==Syntax== | ||
DosPurgeQueue (QueueHandle) | |||
DosPurgeQueue | |||
==Parameters== | ==Parameters== | ||
; | ;QueueHandle (HQUEUE) - input : Handle of the queue to purge. | ||
==Return Code== | ==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== | ==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. | 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=== | ===C Binding=== | ||
<PRE> | <PRE> | ||
| Line 44: | Line 38: | ||
Returns WORD | Returns WORD | ||
</PRE> | </PRE> | ||
[[Category: | [[Category:Dos]] | ||
Revision as of 16:17, 1 March 2017
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.
C Binding
#define INCL_DOSQUEUES USHORT rc = DosPurgeQueue(QueueHandle); HQUEUE QueueHandle; /* Queue handle */ USHORT rc; /* return code */
MASM Binding
EXTRN DosPurgeQueue:FAR INCL_DOSQUEUES EQU 1 PUSH WORD QueueHandle ;Queue handle CALL DosPurgeQueue Returns WORD