osOpenPtrQueue Function
Declaration:
HANDLE osOpenPtrQueue(
  SYSNAME Name
);
Parameters:
Name

The name of the pointer queue object to be opened.

Return value:

Returns a handle to the opened pointer queue object upon success, or NULL_HANDLE on failure. Call the osGetLastError function to retrieve extended error information.

Description:

This function opens an existing pointer queue object by its name.

The pointer queue enables data exchange between tasks using a FIFO (First In, First Out) implementation. Data items are appended to the end of the queue and retrieved from the beginning. The pointer queue stores a fixed number of messages of the PVOID type. The capacity of the queue is determined during its creation.

During the creation of a pointer queue, an optional object name may be assigned, allowing other tasks to access the queue via the osOpenPtrQueue function. When a pointer queue is no longer needed, its handle should be closed using osCloseHandle. The object is deleted only after it has been closed by all tasks that held an open handle. For more details, refer to the System Objects Management section.

If no osOpen* functions are utilized within the application, the system ignores object names and excludes the name management code to reduce the final executable size. For further information regarding object naming and opening, see the System Objects Management section.

For additional information regarding pointer queue objects, refer to the Pointer Queues section.

This function is available only when both the OS_USE_PTR_QUEUE and OS_OPEN_PTR_QUEUE_FUNC constants are set to 1. If this function is not required, set OS_OPEN_PTR_QUEUE_FUNC to 0 to reduce the total code size.

SpaceShadow documentation