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

CloseChannel Method

Closes a existing SSHChannel .

Syntax

sshclient.closeChannel(channelId, [callback])

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 this 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

ChannelId is the identifier for the SSH channel to be closed.

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