record-message-in-windows-event-log

record-message-in-windows-event-log Function

Summary

Records a message in the Windows event log.

Package

win32

Signature

record-message-in-windows-event-log type message &key source-name unc-server-name handle category event-id user-sid data

Arguments

`type`⇩	A keyword.
`message`⇩	A string or list of strings.
`source-name`⇩	A string.
`unc-server-name`⇩	`nil` or a string.
`handle`⇩	`nil` or an open event log handle.
`category`⇩	An integer.
`event-id`⇩	An integer.
`user-sid`⇩	`nil` or a foreign pointer to a SID object.
`data`⇩	`nil` or a string.

Description

The function record-message-in-windows-event-log records a message message in the Windows event log.

type must be one of the keywords :success, :error, :warning, :information, :audit-success or :audit-failure, corresponding to the types of Window event log entry.

message is used as the string (or list of strings) recorded with the event.

If handle is nil, source-name is used as the name of the event source for recording events. If source-name is nil then the name of the Lisp executable is used.

If handle is nil and unc-server-name is non-nil, then it specifies the UNC name of a server which records the events.

If handle is non-nil, then it must be an open event log handle, such as created by with-windows-event-log-event-source. If handle is nil, then source-name is used to open an event log handle for the duration of the call to record-message-in-windows-event-log.

category and event-id are recorded in the event log. They are only useful if you create and register an event source provider DLL in Windows (see MSDN documentation for "Reporting Events").

If user-sid is non-nil, then it is used to record the user that logged the event.

If data is non-nil, then it is recorded as extra data associated with the event.