osPtrQueuePost function

osPtrQueuePost Function

Declaration:

BOOL osPtrQueuePost(
  HANDLE Handle,
  PVOID Ptr
);

Parameters:

Handle

Handle to the pointer queue object.

Ptr

The message to be stored in the queue.

Return value:

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

Description:

This function stores a new message at the end of the pointer queue. If the queue is full, 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, osGetLastError, osPtrQueuePend, osPtrQueuePeek, queue of pointers, PVOID, TRUE

SpaceShadow documentation