recordLength (property)

The length of received data records.

Syntax

- (int)recordLength:(int)sSHChannelId;
- (void)setRecordLength:(int)sSHChannelId:(int)newRecordLength;

public func recordLength(sSHChannelId: Int32) throws -> Int32
public func setRecordLength(sSHChannelId: Int32, newRecordLength: Int32) throws -> Void

Default Value

0

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 SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.
Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 iOS Edition - Version 20.0 [Build 8501]