RecordLength Property

The length of received data records.

Syntax

ANSI (Cross Platform)
int GetRecordLength();
int SetRecordLength(int iRecordLength); Unicode (Windows) INT GetRecordLength();
INT SetRecordLength(INT iRecordLength);
@property (nonatomic,readwrite,assign,getter=recordLength,setter=setRecordLength:) int recordLength;
- (int)recordLength;
- (void)setRecordLength:(int)newRecordLength;
#define PID_PIPECLIENT_RECORDLENGTH 7

IPWORKSIPC_EXTERNAL void* IPWORKSIPC_CALL IPWorksIPC_PipeClient_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSIPC_EXTERNAL int IPWORKSIPC_CALL IPWorksIPC_PipeClient_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

0

Remarks

If set to a positive value, this property 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 property is not used.

This property is not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IPC 2020 C++ Edition - Version 20.0 [Build 8155]