RecordLength Property

The length of received data records.

Syntax

ANSI (Cross Platform)
int GetRecordLength(int iSSHChannelId);
int SetRecordLength(int iSSHChannelId, int iRecordLength);

Unicode (Windows)
INT GetRecordLength(INT iSSHChannelId);
INT SetRecordLength(INT iSSHChannelId, INT iRecordLength);
- (int)recordLength:(int)sSHChannelId;
- (void)setRecordLength:(int)sSHChannelId:(int)newRecordLength;

#define PID_SSHDAEMON_RECORDLENGTH 6

IPWORKSSSH_EXTERNAL void* IPWORKSSSH_CALL IPWorksSSH_SSHDaemon_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SSHDaemon_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SSHDaemon_CheckIndex(void *lpObj, int propid, int arridx);

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.

This property is not available at design time.

Data Type

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