xEventGroupClearBits() - syntax, references, call tree, description

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

   #define BIT_0	( 1 << 0 )
   #define BIT_4	( 1 << 4 )
   void aFunction( EventGroupHandle_t xEventGroup )
   {
   EventBits_t uxBits;
		// Clear bit 0 and bit 4 in xEventGroup.
		uxBits = xEventGroupClearBits(
								xEventGroup,	// The event group being updated.
								BIT_0 | BIT_4 );// The bits being cleared.
		if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )
		{
			// Both bit 0 and bit 4 were set before xEventGroupClearBits() was
			// called.  Both will now be clear (not set).
		}
		else if( ( uxBits & BIT_0 ) != 0 )
		{
			// Bit 0 was set before xEventGroupClearBits() was called.  It will
			// now be clear.
		}
		else if( ( uxBits & BIT_4 ) != 0 )
		{
			// Bit 4 was set before xEventGroupClearBits() was called.  It will
			// now be clear.
		}
		else
		{
			// Neither bit 0 nor bit 4 were set in the first place.
		}
   }
   

References

Location	Referrer	Text
event_groups.c:461		EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear )
event_groups.h:352		EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear ) PRIVILEGED_FUNCTION;
event_groups.c:667	vEventGroupClearBitsCallback()	( void ) xEventGroupClearBits( pvEventGroup, ( EventBits_t ) ulBitsToClear ); /lint !e9079 Can't avoid cast to void as a generic timer callback prototype. Callback casts back to original type so safe. */
mpu_wrappers.c:1171	MPU_xEventGroupClearBits()	xReturn = xEventGroupClearBits( xEventGroup, uxBitsToClear );