DosWriteQueue - Parameters

hq (HQUEUE) - input

The handle of the queue to which an element is to be added.

request (ULONG) - input

A value to be passed with the queue element.

It is used by an application to code an event. The data is understood by the thread that is adding the element to the queue, as well as by the thread that receives the queue element. There is no special meaning to this data, and the operating system does not alter it.

This value is the same as the data in pRequest field of DosPeekQueue operation for examining a queue element.

cbData (ULONG) - input

The length, in bytes, of the data that is being sent to the queue.

pbData (PVOID) - input

A pointer to the buffer that contains the data to be placed into the queue.

priority (ULONG) - input

The priority value of the element that is being added to the queue.

This parameter is valid only for queues that were created as priority-based queues, as specified in the priority parameter of DosCreateQueue. priority is a numerical value in the range of 0 to 15, with 15 being the highest priority.

• If the priority value is 15, the element is added to the top of the queue.

• If the priority value is 0, the element is added as the last element in the queue.

• Elements with the same priority value are grouped together in FIFO (first in, first out) order.
If you assign a value greater than 15 to priority, the system sets priority to 15. No error code is returned for this condition.

ulrc (APIRET) - returns

Return Code.

DosWriteQueue returns one of the following values:

• NO_ERROR 334
  ERROR_QUE_NO_MEMORY
  337
  ERROR_QUE_INVALID_HANDLE
  For a full list of error codes, see Errors.

---

[Back: DosWriteQueue Return Value - ulrc]
[Next: DosWriteQueue - Remarks]