osQueuePeek function

osQueuePeek Function

Declaration:

BOOL osQueuePeek(
  HANDLE Handle,
  PVOID Buffer
);

Parameters:

Handle

The handle to the queue object.

Buffer

A pointer to the buffer where the message will be copied.

Return value:

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

Description:

This function reads the message at the front of the queue without removing it. If the queue is empty, the function fails.

For further details regarding queues, refer to the queue objects section.

This function is available only when the OS_USE_QUEUE and OS_QUEUE_PEEK_FUNC constants are both 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