Creates or opens an event.

HANDLE RtCreateEvent(

    LPSECURITY_ATTRIBUTES lpEventAttributes,

    BOOLEAN ManualReset,

    BOOLEAN bInitialState

    LPCTSTR lpName

);

Parameters

lpEventAttributes

Ignored; set to NULL.

ManualReset

Boolean event type:

TRUE

Use RtResetEvent to manually reset the event to the non-signaled state.

FALSE

The system automatically resets the event after a single waiting thread is released.

bInitialState

Specifies the initial event state:

TRUE

Signaled.

FALSE

Non-signaled.

lpName

Pointer to a null-terminated string that specifies the event object's name. The name is limited to MAX_PATH characters and can contain any character except the backslash path-separator character (\). Name comparison is case sensitive. Values include:

NULL

The event object is created without a name.

Matches an existing named event object

Ignores the ManualReset and bInitialState parameters because they were already set by the creation process.

Matches the name of an existing mutex, semaphore, or shared memory object

The function fails and the Windows' GetLastError function returns ERROR_INVALID_HANDLE. This occurs because these objects share the same name space.

Return Values

Handle of the event object

Success.

NULL

Failure.

Requirements

Notes

• This function operates in the Windows portion of your application.
• The iwin32 API also includes an RtCreateEvent function that operates in the real-time portion of your application.

See Also

RtResetEvent, iwin32x API, iwin32 Overview