IPWorks SSH 2020 Node.js Edition

Questions / Feedback?

SFTPConnectionErrorMessage Property

ErrorMessage is used together with status codes returned from events to send informative errors back to the SFTP client through the SSH_FXP_STATUS message.

Syntax

 sftpserver.getSFTPConnectionErrorMessage(index, [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 getSFTPConnectionErrorMessage([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 setSFTPConnectionErrorMessage([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

SFTPConnectionErrorMessage is used together with status codes returned from events to send informative errors back to the SFTP client through the SSH_FXP_STATUS message. If left blank, the class will set a default message based on the returned status code.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

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