Function esp_idf_hal::sys::vStreamBufferDelete

source ยท
pub unsafe extern "C" fn vStreamBufferDelete(
    xStreamBuffer: *mut StreamBufferDef_t,
)
Expand description

@cond !DOC_EXCLUDE_HEADER_SECTION stream_buffer.h

@code{c} void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer ); @endcode @endcond

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

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

@param xStreamBuffer The handle of the stream buffer to be deleted.

@cond !DOC_SINGLE_GROUP \defgroup vStreamBufferDelete vStreamBufferDelete @endcond \ingroup StreamBufferManagement