Quality RTOS & Embedded Software

  Real time embedded FreeRTOS RSS feed  

vMessageBufferDelete()
[RTOS Message Buffer API]


message_buffer.h

void vMessageBufferDelete( MessageBufferHandle_t xMessageBuffer );

Deletes a message buffer that was previously created using a call to xMessageBufferCreate() or xMessageBufferCreateStatic(). If the message buffer was created using dynamic memory (that is, by xMessageBufferCreate()), then the allocated memory is freed.

A message buffer handle must not be used after the message buffer has been deleted.

Message buffer functionality is enabled by including the FreeRTOS/source/stream_buffer.c source file in the build (as message buffers use stream buffers).

Parameters:
xMessageBuffer   The handle of the message buffer to be deleted.





Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.