UserData Property
The UserData property holds connection specific user specified data.
Syntax
ANSI (Cross Platform) int GetUserData(int iConnectionId, char* &lpUserData, int &lenUserData);
int SetUserData(int iConnectionId, const char* lpUserData, int lenUserData); Unicode (Windows) INT GetUserData(INT iConnectionId, LPSTR &lpUserData, INT &lenUserData);
INT SetUserData(INT iConnectionId, LPCSTR lpUserData, INT lenUserData);
- (NSString*)userData:(int)connectionId; - (void)setUserData:(int)connectionId:(NSString*)newUserData;
- (NSData*)userDataB:(int)connectionId; - (void)setUserDataB:(int)connectionId:(NSData*)newUserData;
#define PID_IPDAEMON_USERDATA 17 IPWORKS_EXTERNAL void* IPWORKS_CALL IPWorks_IPDaemon_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal); IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_IPDaemon_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal); IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_IPDaemon_CheckIndex(void *lpObj, int propid, int arridx);
Default Value
""
Remarks
The UserData 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 ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is not available at design time.
Data Type
Binary String