osClearPtrQueue function

osClearPtrQueue Function

Declaration:

BOOL osClearPtrQueue(
  HANDLE Handle
);

Parameters:

Handle

Handle to the pointer queue object.

Return value:

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

Description:

This function removes all items currently residing in the specified pointer queue.

This function is available only when both the OS_USE_PTR_QUEUE and OS_PTR_QUEUE_CLEAR_FUNC constants are set to 1. For further details regarding pointer queue objects, refer to the Pointer Queues section.

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

SpaceShadow documentation