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

ExitStatus Property

The exit code for the last executed command.

Syntax

 sexec.getExitStatus([callback])

Default Value

0


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 getExitStatus([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 setExitStatus([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

After executing a command through Execute or by setting Command, the server will send a notification containing the ExitStatus of the command. The server may also send a textual representation of that code, which will be stored in ErrorMessage.

This property is read-only.

Data Type

Integer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0