Symbols

Files

loading (1/5)...

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFxRingbufferGetStaticBuffer()

xRingbufferGetStaticBuffer() function

Retrieve the pointers to a statically created ring buffer

Syntax

Show:

Summary

Declaration

Definition

from ringbuf.h:522

BaseType_t xRingbufferGetStaticBuffer(RingbufHandle_t xRingbuffer, uint8_t **ppucRingbufferStorage, StaticRingbuffer_t **ppxStaticRingbuffer);

Implemented in ringbuf.c:1365

Arguments

Argument

Declared as

Description

xRingbuffer

RingbufHandle_t

Ring buffer

ppucRingbufferStorage

uint8_t **

Used to return a pointer to the queue's storage area buffer

ppxStaticRingbuffer

StaticRingbuffer_t **

Used to return a pointer to the queue's data structure buffer

Return value

pdTRUE if buffers were retrieved, pdFALSE otherwise.

References

Code

Location

Referrer

BaseType_t xRingbufferGetStaticBuffer(RingbufHandle_t xRingbuffer, uint8_t **ppucRingbufferStorage, StaticRingbuffer_t **ppxStaticRingbuffer)

ringbuf.c:1365

BaseType_t xRingbufferGetStaticBuffer(RingbufHandle_t xRingbuffer, uint8_t **ppucRingbufferStorage, StaticRingbuffer_t **ppxStaticRingbuffer);

ringbuf.h:522

xResult = xRingbufferGetStaticBuffer(xRingbuffer, &pucRingbufferStorage, &pxStaticRingbuffer);

ringbuf.c:1423

vRingbufferDeleteWithCaps()

Call Tree

xRingbufferGetStaticBuffer() is called by 1 function and calls 1 function:

vRingbufferDeleteWithCaps()

xRingbufferGetStaticBuffer()

__assert_func()

Data Use

xRingbufferGetStaticBuffer() reads 2 variables:

RingbufferDefinition::uxRingbufferFlags

RingbufferDefinition::pucHead

xRingbufferGetStaticBuffer()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out