osClearPtrQueue function
Declaration:
BOOL osClearPtrQueue(
  HANDLE Handle
);
Parameters:
Handle

Handle of queue of pointers object.

Return value:

TRUE on success or FALSE on failure. Use osGetLastError function to obtain extended error information.

Description:

Function removes all items from the queue of pointers.

Function is available only, when the value of OS_USE_PTR_QUEUE and OS_PTR_QUEUE_CLEAR_FUNC constants are set to 1. For more information about the queue of pointers objects see the queue of pointers 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