ClientEOL Property

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

Object Oriented Interface

public function getClientEOL($clientid);
public function setClientEOL($clientid, $value);

Procedural Interface

ipworksssh_sshtunnel_get($res, 9 , $clientid);
ipworksssh_sshtunnel_set($res, 9, $value , $clientid);

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 size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Binary String