xEventGroupGetBits()
[Event Group API]

event_groups.h

 EventBits_t xEventGroupGetBits( EventGroupHandle_t xEventGroup );

Returns the current value of the event bits (event flags) in an RTOS event group. This function cannot be used from an interrupt. See xEventGroupsGetBitsFromISR() for a version that can be used in an interrupt.

The RTOS source file FreeRTOS/source/event_groups.c must be included in the build for the xEventGroupGetBits() function to be available.

Parameters:

xEventGroup

The event group being queried. The event group must have previously been created using a call to xEventGroupCreate().

Returns:

The value of the event bits in the event group at the time xEventGroupGetBits() was called.