Function Reference


_WinAPI_OpenEvent

Opens an existing named event object

#include <WinAPIProc.au3>
_WinAPI_OpenEvent ( $sName [, $iAccess = $EVENT_ALL_ACCESS [, $bInherit = False]] )

Parameters

$sName The name of the event to be opened. Name comparisons are case sensitive.
$iAccess [optional] The access to the event object.
The function fails if the security descriptor of the specified object does not permit the requested access for the calling process.
This parameter can be one of the following values:
    $EVENT_ALL_ACCESS (Default)
    $EVENT_MODIFY_STATE
$bInherit [optional] Specifies whether inherites the handle by a processes, valid values:
    True - The processes created by this process will inherit the handle.
    False - The processes do not inherit this handle (Default).

Return Value

Success: The handle to the event object.
Failure: 0, call _WinAPI_GetLastError() to get extended error information.

Remarks

The function succeeds only if some process has already created the event by using the _WinAPI_CreateEvent() function.
The calling process can use the returned handle in any function that requires a handle to a event object.

Related

_WinAPI_CreateEvent

See Also

Search OpenEvent in MSDN Library.