size_t xMessageBufferNextLengthBytes( MessageBufferHandle_t xMessageBuffer );

StreamBufferHandle_t MessageBufferHandle_t

Type by which message buffers are referenced.

#define xMessageBufferNextLengthBytes(xMessageBuffer)

Returns the length (in bytes) of the next message in a message buffer. Useful if xMessageBufferReceive() returned 0 because the size of the buffer passed into xMessageBufferReceive() was too small to hold the next message.

Parameters

xMessageBuffer The handle of the message buffer being queried.

Returns: The length (in bytes) of the next message in the message buffer, or 0 if the message buffer is empty.