OSWaitEvent

Syntax

#include <cafe/os.h>

void OSWaitEvent(OSEvent* event);

Parameters

event OSEvent to wait for a signal.

Return Values

None.

Description

OSWaitEvent causes the thread to block until the OSEvent is signaled. If the OSEvent is already in the signaled state, this function returns without waiting. If the OSEvent is in Auto Mode, OSEvent will become non-signaled.

Do Not Call From

Callbacks Do not call this function from any callback function.

See Also

OSInitEvent
OSSignalEvent
OSSignalEventAll
OSWaitEventWithTimeout
OSResetEvent

Revision History

2013/05/08 Automated cleanup pass.
2012/08/01 Cleanup pass.
2011/03/02 Added the description of mode.
2010/12/15 Initial version.


CONFIDENTIAL