xMessageBufferNextLengthBytes macro

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.

Syntax

Show:

Summary

Declaration

from message_buffer.h:721

#define xMessageBufferNextLengthBytes( xMessageBuffer ) \ xStreamBufferNextMessageLengthBytes( xMessageBuffer ) PRIVILEGED_FUNCTION;

Arguments

Argument

Description

xMessageBuffer

The handle of the message buffer being queried.

Return value

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

References

Code

Location

#define xMessageBufferNextLengthBytes( xMessageBuffer ) \

message_buffer.h:721

xMessageBufferNextLengthBytes macro

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle