ISession.Unsubscribe Method (ISubscription, Boolean)

Solclient

ISessionUnsubscribe Method (ISubscription, Boolean)
version: 7.2.1.27
Remove a subscription.

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)
Syntax
ReturnCode Unsubscribe(
	ISubscription subscription,
	bool waitForConfirm
)
Function Unsubscribe ( 
	subscription As ISubscription,
	waitForConfirm As Boolean
) As ReturnCode
ReturnCode Unsubscribe(
	ISubscription^ subscription, 
	bool waitForConfirm
)

Parameters

subscription
Type: SolaceSystems.Solclient.MessagingISubscription
The subscription to unsubscribe to.
waitForConfirm
Type: SystemBoolean
If true, this call blocks the calling thread until a reply is received from the appliance.

Return Value

Type: ReturnCode
SOLCLIENT_WOULD_BLOCK or SOLCLIENT_OK or SOLCLIENT_IN_PROGRESS
Exceptions
ExceptionCondition
OperationErrorException Thrown when the Unsubscribe operation fails. Possible sub-codes:
ObjectDisposedException Thrown when the session is already disposed (terminal state).
FatalErrorException Thrown when an unrecoverable error occurs.
ArgumentNullException Thrown if subscription is null.
See Also