Collaboration diagram for uxStreamBufferGetStreamBufferNotificationIndex:

UBaseType_t uxStreamBufferGetStreamBufferNotificationIndex( StreamBufferHandle_t xStreamBuffer );

unsigned long UBaseType_t

Definition portmacro.h:60

struct StreamBufferDef_t * StreamBufferHandle_t

Definition stream_buffer.h:79

uxStreamBufferGetStreamBufferNotificationIndex

UBaseType_t uxStreamBufferGetStreamBufferNotificationIndex(StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION

Get the task notification index used for the supplied stream buffer which can be set using vStreamBufferSetStreamBufferNotificationIndex. If the task notification index for the stream buffer is not changed using vStreamBufferSetStreamBufferNotificationIndex, this function returns the default value (tskDEFAULT_INDEX_TO_NOTIFY).

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

Parameters

xStreamBuffer The handle of the stream buffer for which the task notification index is retrieved.

Returns: The task notification index for the stream buffer.