osPtrQueuePeek function

osPtrQueuePeek Function

Declaration:

BOOL osPtrQueuePeek(
  HANDLE Handle,
  PVOID *Ptr
);

Parameters:

Handle

Handle to the pointer queue object.

Ptr

Pointer to a variable that will receive the retrieved message.

Return value:

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

Description:

This function reads a message from the beginning of the queue without removing 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 both the OS_USE_PTR_QUEUE and OS_PTR_QUEUE_PEEK_FUNC constants are set to 1.

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

SpaceShadow documentation