10.24.0

ISessionSetClientDescription Method

Note: This API is now obsolete.
Sets the Client Description.

Definition

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 10.24.0
C#
[ObsoleteAttribute("Use ModifyProperty(SessionProperties.PROPERTY, object) instead ", 
	false)]
ReturnCode SetClientDescription(
	string clientDescription
)

Parameters

clientDescription  String
string

Return Value

ReturnCode
Throws OperationErrorException if it fails, otherwise it returns SOLCLIENT_WOULD_BLOCK or SOLCLIENT_OK.

Exceptions

OperationErrorException Thrown when the operation fails.
ObjectDisposedException Thrown when the session is already disposed (terminal state).
FatalErrorException Thrown when an unrecoverable error occurs.
ArgumentNullException Thrown if any of the required parameters are null.

See Also