PinnedClientCloseReason Property

Contains the line sent by the client just before closing the connection.

Syntax

 sftpserver.getPinnedClientCloseReason([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 getPinnedClientCloseReason([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 setPinnedClientCloseReason([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

Contains the line sent by the client just before closing the connection. It might contain the error description if the connection was not closed gracefully.

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

Data Type

String