Collapse All Expand All

.NET Framework Class Library
Connection Class See Also

[TIBCO.EMS .NET client library 5.1 documentation]

Gets and Set the Client Id

Namespace: TIBCO.EMS
Assembly: TIBCO.EMS (in TIBCO.EMS.dll)

# Syntax

    public string ClientID { get; set; }

    Public Property ClientID As String

    public:
    property String^ ClientID {
    	String^ get ();
    	void set (String^ value);
    }

#### Return Value

the unique client identifier

# Remarks

This property holds the unique client ID of the connection.

Client IDs partition the namespace of durable subscribers (see Session.CreateDurableSubscriber).

Administrators can configure ConnectionFactory objects to assign client IDs to new connections. Alternatively, administrators can allow client programs to assign their own IDs. If the factory does not assign an ID, the program may dynamically set this property by calling the setClientID method. However, it is illegal to overwrite an existing client ID value, and or to set this property after using the connection in any way (for example, after creating a session, or starting the connection); attempting to set this property in these situations results in IllegalStateException.

# Exceptions

Exception | Condition
--- | ---
TIBCO.EMS..::.IllegalStateException | Attempt to overwrite existing ClientID or to set the ClientID after using the connection.

# See Also

Connection Class
TIBCO.EMS Namespace