OSInitEvent

Syntax

#include <cafe/os.h>

void OSInitEvent(OSEvent* event, BOOL initial_state, s32 mode);

Parameters

event OSEvent to initialize.
initial_state Initial value for the OSEvent. Signaled is TRUE. Not signaled is FALSE.
mode
OS_EVENT_MANUAL Set this event up as a manual event.
OS_EVENT_AUTO Set this event up as an auto event.

Return Values

None.

Description

OSInitEvent initializes an OSEvent for usage. After returning, the OSEvent is available.

If mode is set to OS_EVENT_MANUAL, the event must be reset by the user. If mode is set to OS_EVENT_AUTO, the event will be reset automatically. For more information, see OSSignalEvent.

Do Not Call From

Multiple threads This function is not thread-safe.

See Also

OSSignalEvent
OSSignalEventAll
OSWaitEvent
OSWaitEventWithTimeout
OSResetEvent

Revision History

2013/05/08 Automated cleanup pass.
2012/08/01 Cleanup pass.
2012/05/25 Match actual header.
2011/03/02 added the description of mode.
2010/12/15 Initial version.


CONFIDENTIAL