Command Property

The command to be sent to the remote host.

Syntax

 sshell.getCommand([callback])
 sshell.setCommand( command, [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 getCommand([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 setCommand([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

Assigning a command to this property makes the class attempt to connect to the SSHHost and execute the command under the user's shell. There is no need to append an end-of-line character to the command. All output from the remote application will be returned through the Stdout event.

Data Type

String