LogEvent Method

Adds an event entry to a log file.

object.LogEvent(intType, strMessage [,strTarget]) 

Arguments

object

WshShell object.

intType

Integer value representing the event type.

strMessage

String value containing the log entry text.

strTarget

Optional. String value indicating the name of the computer system where the event log is stored (the default is the local computer system). Applies to Windows NT/2000 only.

Remarks

The LogEvent method returns a Boolean value (true if the event is logged successfully, otherwise false). In Windows NT/2000, events are logged in the Windows NT Event Log. In Windows 9x/Me, events are logged in WSH.log (located in the Windows directory). There are six event types.

Example

The following code logs SUCCESS or ERROR depending on the outcome of the function runLoginScript().

Set WshShell = WScript.CreateObject("WScript.Shell")
rc = runLoginScript()      'Returns true if logon succeeds.

if rc then
   WshShell.LogEvent 0, "Logon Script Completed Successfully"
else
   WshShell.LogEvent 1, "Logon Script failed"
end if

var WshShell = WScript.CreateObject("WScript.Shell");
var rc = runLoginScript();

if (rc) 
   WshShell.LogEvent(0, "Logon Script Completed Successfully");
else
   WshShell.LogEvent(1, "Logon Script failed");

See Also

WshShell Object