osPtrQueuePend function

osPtrQueuePend Function

Declaration:

BOOL osPtrQueuePend(
  HANDLE Handle,
  PVOID *Ptr
);

Parameters:

Handle

Handle to the pointer queue object.

Ptr

Pointer to a variable that will receive the message retrieved from the queue.

Return value:

TRUE on success or FALSE on failure. Call the osGetLastError function to retrieve extended error information.

Description:

This function retrieves a message from the beginning of the queue and subsequently removes it. If the queue is empty, the function fails.

For additional information regarding pointer queue objects, refer to the Pointer Queues section.

This function is available only when the 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