SecureBlackbox Lite 2020 Node.js Edition

Questions / Feedback?

SendSpecial Method

Sends a special character to the server or remote command.

Syntax

sshclient.sendSpecial(specialChar, [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

Use this method to send a special or control character to the SSH server or the command being executed. Specify the character id via the SpecialChar parameter.

Currently the only supported special character is "eof", which is sometimes used as a way to close the stdin channel gracefully.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox Lite 2020 Node.js Edition - Version 20.0 [Build 8166]