xMessageBufferCreateWithCaps() function

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

Syntax

Show:

Summary

Declaration

from idf_additions.h:575

static inline MessageBufferHandle_t xMessageBufferCreateWithCaps( size_t xBufferSizeBytes, UBaseType_t uxMemoryCaps );

Arguments

Argument

Description

xBufferSizeBytes

The total number of bytes (not messages) the message buffer will be able to hold at any one time.

uxMemoryCaps

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

Return value

Handle to the created message buffer or NULL on failure.

Notes

A message buffer created using this function must only be deleted using vMessageBufferDeleteWithCaps()

References

Code

Location

static inline MessageBufferHandle_t xMessageBufferCreateWithCaps( size_t xBufferSizeBytes,

idf_additions.h:575

Call Tree

xMessageBufferCreateWithCaps() calls 1 function:

xMessageBufferCreateWithCaps()

xStreamBufferGenericCreateWithCaps()

Data Use

xMessageBufferCreateWithCaps():

xMessageBufferCreateWithCaps()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out