ClientEOL Property
The EOL property is used to define boundaries in the input stream using the value of the property.
Syntax
ANSI (Cross Platform) int GetClientEOL(int iClientId, char* &lpClientEOL, int &lenClientEOL);
int SetClientEOL(int iClientId, const char* lpClientEOL, int lenClientEOL); Unicode (Windows) INT GetClientEOL(INT iClientId, LPSTR &lpClientEOL, INT &lenClientEOL);
INT SetClientEOL(INT iClientId, LPCSTR lpClientEOL, INT lenClientEOL);
- (NSString*)clientEOL:(int)clientId; - (void)setClientEOL:(int)clientId:(NSString*)newClientEOL;
- (NSData*)clientEOLB:(int)clientId; - (void)setClientEOLB:(int)clientId:(NSData*)newClientEOL;
#define PID_SSHTUNNEL_CLIENTEOL 9 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
""
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 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
Binary String