OS_Clear*Event

Syntax

#include <nitro/os.h>
void OS_ClearEvent( OSEvent* event, u32 clearBit );
void OS_ClearAllEvent( OSEvent* event );
  
  

Arguments

event Pointer to an event structure whose event flag will be cleared.
clearBit The bit of the event flag to clear.

Return Values

None.

Description

Clears an event flag member of the event structure.

event is a pointer to an event structure. OS_ClearEvent() will clear the event flag member of event for the bit indicated by clearBit.

OS_ClearAllEvent() will clear all bits. In other words, it sets the event flag of event to 0.

Internally, this just sets a value for the member of the structure, so the system will not switch threads as a result of this function.

See Also

OS_InitEvent, OS_WaitEvent*, OS_SignalEvent, OS_PollEvent*, OS Overview (Events)

Revision History

2007/12/04 Initial version.


CONFIDENTIAL