xMessageBufferGetStaticBuffers macro

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.

Syntax

Show:

Summary

Declaration

from message_buffer.h:259

#define xMessageBufferGetStaticBuffers( xMessageBuffer, ppucMessageBufferStorageArea, ppxStaticMessageBuffer ) \ xStreamBufferGetStaticBuffers( ( xMessageBuffer ), ( ppucMessageBufferStorageArea ), ( ppxStaticMessageBuffer ) )

Arguments

Argument

Description

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.

Return value

pdTRUE if buffers were retrieved, pdFALSE otherwise.

References

Code

Location

#define xMessageBufferGetStaticBuffers( xMessageBuffer, ppucMessageBufferStorageArea, ppxStaticMessageBuffer ) \

message_buffer.h:259

xResult = xMessageBufferGetStaticBuffers( xStreamBuffer, &pucStreamBufferStorageArea, &pxStaticStreamBuffer );

idf_additions.c:397

xMessageBufferGetStaticBuffers macro

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle