EOL Property

The EOL property is used to define boundaries in the input stream using the value of the property.

Syntax

ANSI (Cross Platform)
int GetEOL(int iConnectionId, char* &lpEOL, int &lenEOL);
int SetEOL(int iConnectionId, const char* lpEOL, int lenEOL); Unicode (Windows) INT GetEOL(INT iConnectionId, LPSTR &lpEOL, INT &lenEOL);
INT SetEOL(INT iConnectionId, LPCSTR lpEOL, INT lenEOL);
- (NSString*)EOL:(int)connectionId;
- (void)setEOL:(int)connectionId:(NSString*)newEOL;

- (NSData*)EOLB:(int)connectionId; - (void)setEOLB:(int)connectionId:(NSData*)newEOL;
#define PID_IPDAEMON_EOL 8

IPWORKS_EXTERNAL void* IPWORKS_CALL IPWorks_IPDaemon_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_IPDaemon_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_IPDaemon_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

""

Remarks

The EOL property is used to define boundaries in the input stream using the value of the property.

The EOL property is especially useful with ASCII files. Setting it to CRLF ("\r\n") enables splitting of the incoming ASCII text stream into lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF ("\r\n") . bytes are discarded.

The EOL property is a binary string. In particular, this means that it can be more than one byte long, and it can contain NULL bytes.

When reading the value of the property, if ConnectionId does not belong to a valid connection, then NULL will be returned, and the LastError property will contain a corresponding error message. If no error is encountered, then LastError will contain NULL.

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

This property is not available at design time.

Data Type

Binary String

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