IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

RemoteHost Property

The address of a host to trace to.

Syntax

 traceroute.getRemoteHost([callback])
 traceroute.setRemoteHost( remoteHost, [callback])

Default Value

""


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getRemoteHost([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setRemoteHost([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Traces are initiated by setting RemoteHost to the name or address of the host to trace to.

This property must contain a valid Internet domain name or address or an error will be returned.

To interrupt a trace in progress, set RemoteHost to empty string.

Example (Perform a TraceRoute)


TraceRouteControl.TraceTo("myHost")
is equivalent to
TraceRouteControl.RemoteHost = "myHost"

Data Type

String

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0