osQueuePeek function
Declaration:
BOOL osQueuePeek(
  HANDLE Handle,
  PVOID Buffer
);
Parameters:
Handle

Handle of queue object.

Buffer

Pointer to buffer 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, but does not remove it. When queue is empty, the function fails.

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

Function is available only, when the value of OS_USE_QUEUE and OS_QUEUE_PEEK_FUNC constants is set to 1.

Version:1.0
Header file:OS_Queue.h (include OS_API.h)
See also: BOOL, FALSE, HANDLE, OS_QUEUE_PEEK_FUNC, OS_USE_QUEUE, osCreateQueue, osGetLastError, osQueuePost, osQueuePend, PVOID, queues, TRUE
SpaceShadow documentation