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

RemotePort Property

The remote shell service port (default is 514).

Syntax

 rshell.getRemotePort([callback])
 rshell.setRemotePort( remotePort, [callback])

Default Value

514


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 getRemotePort([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 setRemotePort([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

This property specifies the rshell service port on the remote host.

A valid port number (a value between 1 and 65535) is required for the connection to take place. This property must be set before command execution is attempted.

This property is not available at design time.

Data Type

Long

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