Windows Script Host

Description Property (WshRemoteError)

See Also Example

Collapse All Expand All DropDown image

Language Filter: All Language Filter: Multiple Language Filter: Visual Basic Language Filter: C# Language Filter: C++ Language Filter: J# Language Filter: JScript

Visual Basic (Declaration)
Visual Basic (Usage)
C#
C++
J#
JScript

Contains a brief description of the error that caused the remote script to terminate.


Object.Description

Arguments

Object: WshRemoteError object.

Remarks

The Description property returns a string.

If an error description is not available, the Description property returns an empty string.

Example

The following JScript code demonstrates how the WshRemoteError object exposes the description of the error.

Visual Basic Script	Copy Code
Dim Controller, RemoteScript Set Controller = WScript.CreateObject("WSHController") Set RemoteScript = Controller.CreateScript("test.js", "remoteserver") WScript.ConnectObject RemoteScript, "remote_" RemoteScript.Execute Do While RemoteScript.Status <> 2 WScript.Sleep 100 Loop Sub remote_Error Dim theError Set theError = RemoteScript.Error WScript.Echo "Error - Line: " & theError.Line & ", Char: " & theError.Character & vbCrLf & "Description: " & theError.Description WScript.Quit -1 End Sub

Visual Basic Script

Copy Code

Dim Controller, RemoteScript
Set Controller = WScript.CreateObject("WSHController")
Set RemoteScript = Controller.CreateScript("test.js", "remoteserver")
WScript.ConnectObject RemoteScript, "remote_"
RemoteScript.Execute
Do While RemoteScript.Status <> 2 
    WScript.Sleep 100
Loop
Sub remote_Error
    Dim theError
    Set theError = RemoteScript.Error
    WScript.Echo "Error - Line: " & theError.Line & ", Char: " & theError.Character & vbCrLf & "Description: " & theError.Description
    WScript.Quit -1
End Sub

JScript	Copy Code
var Controller = WScript.CreateObject("WSHController"); var RemoteScript = Controller.CreateScript("test.js", "remoteserver"); WScript.ConnectObject(RemoteScript, "remote_"); RemoteScript.Execute(); while (RemoteScript.Status != 2) { WScript.Sleep(100); } function remote_Error() { var theError = RemoteScript.Error; WScript.Echo("Error - Line: " + theError.Line + ", Char: " + theError.Character + "\nDescription: " + theError.Description); WScript.Quit(-1); }

JScript

Copy Code

var Controller = WScript.CreateObject("WSHController");
var RemoteScript = Controller.CreateScript("test.js", "remoteserver");
WScript.ConnectObject(RemoteScript, "remote_");
RemoteScript.Execute();
while (RemoteScript.Status != 2) {
    WScript.Sleep(100);
}
function remote_Error()
{
    var theError = RemoteScript.Error;
    WScript.Echo("Error - Line: " + theError.Line + ", Char: " + theError.Character + "\nDescription: " + theError.Description);
    WScript.Quit(-1);
}

Applies To:

WshRemoteError Object

Arguments

Remarks

Example

Applies To:

See Also

Reference

Send Help Center Feedback