xStreamBufferGetStaticBuffers

Collaboration diagram for xStreamBufferGetStaticBuffers:

stream_buffer.h

BaseType_t xStreamBufferGetStaticBuffers( StreamBufferHandle_t xStreamBuffer,
                                          uint8_t ** ppucStreamBufferStorageArea,
                                          StaticStreamBuffer_t ** ppxStaticStreamBuffer );

Retrieve pointers to a statically created stream buffer's data structure buffer and storage area buffer. These are the same buffers that are supplied at the time of creation.

configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for xStreamBufferGetStaticBuffers() to be available.

Parameters

xStreamBuffer	The stream buffer for which to retrieve the buffers.
ppucStreamBufferStorageArea	Used to return a pointer to the stream buffer's storage area buffer.
ppxStaticStreamBuffer	Used to return a pointer to the stream buffer's data structure buffer.

Returns

pdTRUE if buffers were retrieved, pdFALSE otherwise.