OpenEventLogA function

Opens a handle to the specified event log.

Syntax

HANDLE OpenEventLogA(
  LPCSTR lpUNCServerName,
  LPCSTR lpSourceName
);

Parameters

lpUNCServerName

The Universal Naming Convention (UNC) name of the remote server on which the event log is to be opened. If this parameter is NULL, the local computer is used.

lpSourceName

The name of the log.

If you specify a custom log and it cannot be found, the event logging service opens the Application log; however, there will be no associated message or category string file.

Return Value

If the function succeeds, the return value is the handle to an event log.

If the function fails, the return value is NULL. To get extended error information, call GetLastError.

Remarks

To close the handle to the event log, use the CloseEventLog function.

Examples

For an example, see Querying for Event Information.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winbase.h (include Windows.h)
Library Advapi32.lib
DLL Advapi32.dll

See Also

ClearEventLog

CloseEventLog

Event Logging Functions

Eventlog Key

ReadEventLog

ReportEvent