osClearQueue function

osClearQueue Function

Declaration:

BOOL osClearQueue(
  HANDLE Handle
);

Parameters:

Handle

The handle to the queue object.

Return value:

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

Description:

This function removes all items from the specified queue.

This function is available only when the OS_USE_QUEUE and OS_QUEUE_CLEAR_FUNC constants are both set to 1. For more information regarding queues, refer to the queue objects section.

Version:	1.0
Header file:	OS_Queue.h (include OS_API.h)
See also:	BOOL, FALSE, HANDLE, OS_QUEUE_CLEAR_FUNC, OS_USE_QUEUE, osCreateQueue, osGetLastError, queues, TRUE

SpaceShadow documentation

About SpaceShadow products
Architecture dependencies
- Creating a port files
  - API File Template
  - Types File Template
  - Time management
  - Context switching
    - Functions
    - Types
  - Constants
  - Modifiers
    - CALLBACK
    - FAR
    - INLINE
    - NEAR
  - Configuration
    - AR_USE_64_BIT
    - AR_USE_DEINIT_FUNC
  - Functions
    - arDeinit
    - arInit
  - Macros
    - AR_MEMORY_ALIGN_UP
    - AR_UNUSED_PARAM
  - Types
    - BOOL
    - INDEX
    - INT8
    - INT16
    - INT32
    - INT64
    - LONG
    - PSTR
    - PVOID
    - SIZE
    - UINT8
    - UINT16
    - UINT32
    - UINT64
    - ULONG
- Ports
  - ARM
    - Generic ARM
    - AT91SAM7S
  - 80x86
    - 80x86 Real Mode
  - Virtual Devices
    - WIN32
Standard Library
Operating System Kernel