osPtrQueuePend function
Declaration:
BOOL osPtrQueuePend(
  HANDLE Handle,
  PVOID *Ptr
);
Parameters:
Handle

Handle of queue of pointers object.

Ptr

Queue of pointers to variable that receives a message.

Return value:

TRUE on success or FALSE on failure. Use osGetLastError function to obtain extended error information.

Description:

Function reads a message from the queue beginning and then removes it. When queue is empty, the function fails.

For more information about the queue of pointers objects see the queue of pointers section.

Function is available only, when the value of OS_USE_PTR_QUEUE constant is set to 1.

Version:1.0
Header file:OS_PtrQueue.h (include OS_API.h)
See also: BOOL, FALSE, HANDLE, OS_USE_PTR_QUEUE, osCreatePtrQueue, osPtrQueuePost, osPtrQueuePeek, queue of pointers, PVOID, osGetLastError, TRUE
SpaceShadow documentation