xMessageBufferGetStaticBuffers

Collaboration diagram for xMessageBufferGetStaticBuffers:

message_buffer.h

BaseType_t xMessageBufferGetStaticBuffers( MessageBufferHandle_t xMessageBuffer,
                                           uint8_t ** ppucMessageBufferStorageArea,
                                           StaticMessageBuffer_t ** ppxStaticMessageBuffer );

Retrieve pointers to a statically created message 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 xMessageBufferGetStaticBuffers() to be available.

Parameters

xMessageBuffer	The message buffer for which to retrieve the buffers.
ppucMessageBufferStorageArea	Used to return a pointer to the message buffer's storage area buffer.
ppxStaticMessageBuffer	Used to return a pointer to the message buffer's data structure buffer.

Returns

pdTRUE if buffers were retrieved, pdFALSE otherwise..