OS_InitEvent

Syntax

#include <nitro/os.h>
void OS_InitEvent( OSEvent* event );
  

Arguments

event Pointer to the event structure to be initialized.

Return Values

None.

Description

Initializes the event structure.

Initializes the event structure used for "synchronous wait" system events. The event argument is a pointer to the event structure to be initialized. Be sure to allocate the instance on the application side.

This function sets the structure's event flag member to 0, and initializes the structure's thread queue member.

Example:

OSEvent myEvent;

OS_InitEvent( &myEvent );

See Also

OS_WaitEvent*
OS_SignalEvent
OS_Clear*Event
OS_PollEvent*
OS Overview (Events)

Revision History

2007/12/04 Initial version.


CONFIDENTIAL