xMessageBufferReset()
[RTOS 消息缓冲区 API]

message_buffer.h

BaseType_t xMessageBufferReset( MessageBufferHandle_t xMessageBuffer );

将消息缓冲区重置为其初始空状态。 任何在消息缓冲区的数据 都被丢弃。 只有没有任务处于阻塞态以等待向消息缓冲区发送或从消息缓冲区接收时， 消息缓冲区才能被重置 。

通过在构建中包含 FreeRTOS/source/stream_buffer.c 源文件 来启用消息缓冲区功能（因为消息缓冲区使用流缓冲区）。

参数：

xMessageBuffer

正在重置的消息缓冲区的句柄。

返回：

如果重置消息缓冲区，则返回 pdPASS。 如果有 一个任务处于阻塞态，等待向消息缓冲区发送或从消息缓冲区读取， 则消息缓冲区将不会被重置，并返回 pdFAIL。