Skip to content

Group xEventGroupClearBits

Modules > xEventGroupClearBits

More...

Detailed Description

event_groups.h

Clear bits within an event group. This function cannot be called from an interrupt.

Parameters:

  • xEventGroup The event group in which the bits are to be cleared.
  • uxBitsToClear A bitwise value that indicates the bit or bits to clear in the event group. For example, to clear bit 3 only, set uxBitsToClear to 0x08. To clear bit 3 and bit 0 set uxBitsToClear to 0x09.

Returns:

The value of the event group before the specified bits were cleared.

Example usage: