IPWorks SSH 2020 Node.js Edition

Questions / Feedback?

SSHLogoff Method

Logoff from the SSH server.

Syntax

sftp.SSHLogoff([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

Logoff from the SSH server. If that fails, the connection is terminated by the local host.

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 Node.js Edition - Version 20.0 [Build 8501]