Retrieves a registered handle to the specified event log.

Syntax

HANDLE RegisterEventSource(
  __in  LPCTSTR lpUNCServerName,
  __in  LPCTSTR lpSourceName
);

Parameters

lpUNCServerName [in]

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

lpSourceName [in]

The name of the event source whose handle is to be retrieved. The source name must be a subkey of a log under the Eventlog registry key.

However, the Security log is for system use only.

Return Value

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

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

The function returns ERROR_INVALID_HANDLE if lpSourceName specifies the Security event log.

Remarks

If the source name cannot be found, the event logging service uses the Application log. Although events will be reported , the events will not include descriptions because there are no message and category message files for looking up descriptions related to the event identifiers.

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

Examples

For an example, see Reporting an Event.

Requirements

See Also

Event Logging Functions

Event Sources

DeregisterEventSource

ReportEvent

Send comments about this topic to Microsoft

Build date: 7/2/2009