ISession.SetClientDescription Method

Solclient

ISessionSetClientDescription Method

version: 7.2.1.27

Note: This API is now obsolete.

Sets the Client Description.

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)

Syntax

C++

Copy

[ObsoleteAttribute("Use ModifyProperty(SessionProperties.PROPERTY, object) instead ", 
	false)]
ReturnCode SetClientDescription(
	string clientDescription
)

<ObsoleteAttribute("Use ModifyProperty(SessionProperties.PROPERTY, object) instead ", 
	false)>
Function SetClientDescription ( 
	clientDescription As String
) As ReturnCode

[ObsoleteAttribute(L"Use ModifyProperty(SessionProperties.PROPERTY, object) instead ", 
	false)]
ReturnCode SetClientDescription(
	String^ clientDescription
)

Parameters

clientDescription: Type: SystemString
string

Return Value

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

Exceptions

Exception	Condition
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.

Reference

ISession Interface

SolaceSystems.Solclient.Messaging Namespace

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use and copy the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

UNLESS STATED ELSEWHERE BETWEEN YOU AND SOLACE SYSTEMS, INC., THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Send comments on this topic to [email protected]

previous page start next page