ClientUserData Property
The UserData property holds connection specific user specified data.
Syntax
ANSI (Cross Platform) int GetClientUserData(int iClientId, char* &lpClientUserData, int &lenClientUserData);
int SetClientUserData(int iClientId, const char* lpClientUserData, int lenClientUserData); Unicode (Windows) INT GetClientUserData(INT iClientId, LPSTR &lpClientUserData, INT &lenClientUserData);
INT SetClientUserData(INT iClientId, LPCSTR lpClientUserData, INT lenClientUserData);
- (NSString*)clientUserData:(int)clientId; - (void)setClientUserData:(int)clientId:(NSString*)newClientUserData;
- (NSData*)clientUserDataB:(int)clientId; - (void)setClientUserDataB:(int)clientId:(NSData*)newClientUserData;
#define PID_SSHTUNNEL_CLIENTUSERDATA 18 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 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