xQueueCreateWithCaps() function

Creates a queue with specific memory capabilities This function is similar to xQueueCreate(), except that it allows the memory allocated for the queue to have specific capabilities (e.g., MALLOC_CAP_INTERNAL).

Syntax

Show:

Summary

Declaration

Definition

from idf_additions.h:372

QueueHandle_t xQueueCreateWithCaps( UBaseType_t uxQueueLength, UBaseType_t uxItemSize, UBaseType_t uxMemoryCaps );

Implemented in idf_additions.c:194

Arguments

Argument

Description

uxQueueLength

The maximum number of items that the queue can contain.

uxItemSize

The number of bytes each item in the queue will require.

uxMemoryCaps

Memory capabilities of the queue's memory (see esp_heap_caps.h)

Return value

Handle to the created queue or NULL on failure.

Notes

A queue created using this function must only be deleted using vQueueDeleteWithCaps()

Examples

xQueueCreateWithCaps() is referenced by 2 libraries and example projects:

References

from examples

xQueueCreateWithCaps() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle