RtOpenEvent

RtOpenEvent returns a handle of an existing named event object.

Syntax

HANDLE RtOpenEvent(
    DWORD DesiredAccess,
    BOOL bInheritHandle,
    LPCTSTR lpName
);

Parameters

DesiredAccess

Ignored.

bInheritHandle

Ignored.

lpName

A pointer to a null-terminated string that names the event to be opened. Name comparisons are case-sensitive.

Return Value

If the function succeeds, it returns a handle to the event object. If the function fails, it returns a NULL value.

To get extended error information, call GetLastError.

Remarks

RtOpenEvent enables multiple processes to open handles of the same event object. The function succeeds only if some process has already created the event by using RtCreateEvent. The calling process can use the returned handle in any function that requires a handle of an event object, such as a wait function.

Use RtCloseHandle to close the handle. The system closes the handle automatically when the process terminates. The event object is destroyed when its last handle has been closed.

See Also:

• RtCloseHandle
• RtCreateEvent
• RtPulseEvent
• RtResetEvent
• RtSetEvent