xMessageBufferReset macro

Resets a message buffer to its initial empty state, discarding any message it contained. A message buffer can only be reset if there are no tasks blocked on it.

Syntax

Show:

Summary

Declaration

from message_buffer.h:682

#define xMessageBufferReset( xMessageBuffer ) \ xStreamBufferReset( xMessageBuffer )

Arguments

Argument

Description

xMessageBuffer

The handle of the message buffer being reset.

Return value

If the message buffer was reset then pdPASS is returned. If the message buffer could not be reset because either there was a task blocked on the message queue to wait for space to become available, or to wait for a a message to be available, then pdFAIL is returned.

References

Code

Location

#define xMessageBufferReset( xMessageBuffer ) \

message_buffer.h:682

xMessageBufferReset macro

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle