ISession.ModifyProperty Method

Solclient

previous page next page

Solclient

ISessionModifyProperty Method

version: 7.2.1.27

Allows certain properties of a session to be modified after the session has been created. Currently, only the following session properties can be modified:
ClientDescription (Deprecated - See Note below)
ClientName (Deprecated - See Note below)
Host (may only be modified when session is disconnected)
Port (may only be modified when session is disconnected)
Note: Applications shall use ModifyClientInfo(SessionPropertiesPROPERTY, Object, Int32, Object) to modify the following session properties:
ClientDescription
ClientName

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

ReturnCode ModifyProperty(
	SessionPropertiesPROPERTY sessionProperty,
	Object value
)

Function ModifyProperty ( 
	sessionProperty As SessionPropertiesPROPERTY,
	value As Object
) As ReturnCode

ReturnCode ModifyProperty(
	SessionPropertiesPROPERTY sessionProperty, 
	Object^ value
)

Parameters

sessionProperty: Type: SolaceSystems.Solclient.MessagingSessionPropertiesPROPERTY
The property to modify.
value: Type: SystemObject
The new value for the property.

Return Value

Type: ReturnCode
Throws OperationErrorException if failed. Otherwise it returns SOLCLIENT_OK, or SOLCLIENT_WOULD_BLOCK, if the message cannot be accepted by the API immediately.

Exceptions

Exception	Condition
OperationErrorException	Thrown when the operation fails. Possible sub-codes: AttemptToModifySessionPropertyWhenNotIdle
FatalErrorException	Thrown when un-recoverable error occurs.
ObjectDisposedException	Thrown when the session is already disposed (terminal state).
ArgumentNullException	Thrown if any of the required parameters is 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