IPWorks SSH 2020 Node.js Edition

Questions / Feedback?

RecordLength Property

The length of received data records.

Syntax

 sshclient.getRecordLength(index, [callback])
 sshclient.setRecordLength(index,  recordLength, [callback])

Default Value

0

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 getRecordLength([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 setRecordLength([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

The length of received data records. If set to a positive value, this setting defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

The default value is 0, meaning this setting is not used.

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

This property is not available at design time.

Data Type

Integer

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