ClientUserData Property

The UserData property holds connection specific user specified data.

Object Oriented Interface

public function getClientUserData($clientid);
public function setClientUserData($clientid, $value);

Procedural Interface

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

Default Value

''

Remarks

The ClientUserData property holds connection specific user specified data.

User specified data may be set or retrieved at any point while the connection is valid. This provides a simple way to associate arbitrary data with a specific connection.

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