ISession.Unsubscribe Method (ITopicEndpoint, Int32)

Solclient

ISessionUnsubscribe Method (ITopicEndpoint, Int32)
version: 7.2.1.27

Note: This API is now obsolete.

Unsubscribes from a durable Topic Endpoint.

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)
Syntax
[ObsoleteAttribute("Use Unsubscribe(ITopicEndpoint,object) instead ", 
	false)]
ReturnCode Unsubscribe(
	ITopicEndpoint dte,
	int correlationId
)
<ObsoleteAttribute("Use Unsubscribe(ITopicEndpoint,object) instead ", 
	false)>
Function Unsubscribe ( 
	dte As ITopicEndpoint,
	correlationId As Integer
) As ReturnCode
[ObsoleteAttribute(L"Use Unsubscribe(ITopicEndpoint,object) instead ", 
	false)]
ReturnCode Unsubscribe(
	ITopicEndpoint^ dte, 
	int correlationId
)

Parameters

dte
Type: SolaceSystems.Solclient.MessagingITopicEndpoint
The durable Topic Endpoint to unsubscribe from.
correlationId
Type: SystemInt32
Correlation Id used in the unsubscribe request and returned in the session event CorrelationKey. Valid values are within [1..16777215]. A value of 0 (zero) indicates that correlationId is not to be returned (in this case CorrelationKey will be null). Any other value outside of the previously stated values will cause an ArgumentOutOfRangeException exception to be thrown.

Return Value

Type: ReturnCode
The return code from the unsubscribe request.
Exceptions
ExceptionCondition
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 is null.
ArgumentOutOfRangeException Thrown if correlationId is out of range.
See Also