clientUserData (property)

The UserData property holds connection specific user specified data.

Syntax

- (NSString*)clientUserData:(int)clientId;
- (void)setClientUserData:(int)clientId:(NSString*)newClientUserData;

- (NSData*)clientUserDataB:(int)clientId;
- (void)setClientUserDataB:(int)clientId:(NSData*)newClientUserData;
public func clientUserData(clientId: Int32) throws -> String
public func setClientUserData(clientId: Int32, newClientUserData: String) throws -> Void

public func clientUserDataB(clientId: Int32) throws -> Data
public func setClientUserDataB(clientId: Int32, newClientUserData: Data) throws -> Void

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.
Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 iOS Edition - Version 20.0 [Build 8501]