ClientConnected Property

This property is used to disconnect individual connections and/or show their status.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetClientConnected(int iClientId);
int SetClientConnected(int iClientId, int bClientConnected);

Unicode (Windows)
BOOL GetClientConnected(INT iClientId);
INT SetClientConnected(INT iClientId, BOOL bClientConnected);

- (BOOL)clientConnected:(int)clientId;
- (void)setClientConnected:(int)clientId:(BOOL)newClientConnected;

#define PID_SSHTUNNEL_CLIENTCONNECTED 6

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

FALSE

Remarks

This property is used to disconnect individual connections and/or show their status.

The ClientConnected property may be set to false to close the connection.

ClientConnected also shows the status of a particular connection (connected/disconnected).

How and when the connection is closed is controlled by the Linger property. Please refer to its description for more information.

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

Boolean