xMessageBufferReset

Collaboration diagram for xMessageBufferReset:

message_buffer.h

BaseType_t xMessageBufferReset( MessageBufferHandle_t xMessageBuffer );

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.

Use xMessageBufferReset() to reset a message buffer from a task. Use xMessageBufferResetFromISR() to reset a message buffer from an interrupt service routine (ISR).

configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for xMessageBufferReset() to be available.

Parameters

xMessageBuffer

The handle of the message buffer being reset.

Returns

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.