ClientRecordLength Property

If set to a positive value, this setting defines the length of data records to be received.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetClientRecordLength(int iClientId);
int SetClientRecordLength(int iClientId, int iClientRecordLength);

Unicode (Windows)
INT GetClientRecordLength(INT iClientId);
INT SetClientRecordLength(INT iClientId, INT iClientRecordLength);

- (int)clientRecordLength:(int)clientId;
- (void)setClientRecordLength:(int)clientId:(int)newClientRecordLength;

#define PID_SSHTUNNEL_CLIENTRECORDLENGTH 13

IPWORKSSSH_EXTERNAL void* IPWORKSSSH_CALL IPWorksSSH_SSHTunnel_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SSHTunnel_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SSHTunnel_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

0

Remarks

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.

A value of 0 (default) means this setting is not used.

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

This property is not available at design time.

Data Type

Integer