Session.Unsubscribe Method (IList(Subscription), String)

SessionUnsubscribe Method (IListSubscription, String)

Cancels previous requests for asynchronous topic updates associated with the correlation ids listed in the specified subscriptionList.

Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.11.1

Syntax

C++

Copy

public void Unsubscribe(
	IList<Subscription> subscriptionList,
	string requestLabel
)

Public Sub Unsubscribe ( 
	subscriptionList As IList(Of Subscription),
	requestLabel As String
)

public:
virtual void Unsubscribe(
	IList<Subscription^>^ subscriptionList, 
	String^ requestLabel
) sealed

abstract Unsubscribe : 
        subscriptionList : IList<Subscription> * 
        requestLabel : string -> unit 
override Unsubscribe : 
        subscriptionList : IList<Subscription> * 
        requestLabel : string -> unit

Parameters

subscriptionList: Type: System.Collections.GenericIListSubscription
A list of correlationIds of subscriptions that are to be unsubscribed.
requestLabel: Type: SystemString
A label that defines a string which will be recorded along with any diagnostics for this operation.

Implements

ISessionUnsubscribe(IListSubscription, String)

Exceptions

Exception	Condition
ArgumentNullException	subscriptionList is null.
InvalidOperationException	Session is not started.

Remarks

This operation provides a convenience for cancelling Subscriptions using a list of subscriptions.

See Cancel(IList, string) operation for more information on the handling of cancel requests and other important notes.

Reference

Session Class

Unsubscribe Overload

Bloomberglp.Blpapi Namespace