Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
xStreamBufferIsEmpty

stream_buffer.h

BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer );

Queries a stream buffer to see if it is empty. A stream buffer is empty if it does not contain any data.

Parameters
xStreamBufferThe handle of the stream buffer being queried.
Returns
If the stream buffer is empty then pdTRUE is returned. Otherwise pdFALSE is returned.