AbstractSession.Cancel Method (CorrelationID, String)

AbstractSessionCancel Method (CorrelationID, String)

Cancels an outstanding request or a subscription represented by the specified correlationId.

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

Syntax

public void Cancel(
	CorrelationID correlationId,
	string requestLabel
)

Public Sub Cancel ( 
	correlationId As CorrelationID,
	requestLabel As String
)

public:
virtual void Cancel(
	CorrelationID^ correlationId, 
	String^ requestLabel
) sealed

abstract Cancel : 
        correlationId : CorrelationID * 
        requestLabel : string -> unit 
override Cancel : 
        correlationId : CorrelationID * 
        requestLabel : string -> unit

Parameters

correlationId: Type: Bloomberglp.BlpapiCorrelationID
requestLabel: Type: SystemString

Implements

IAbstractSessionCancel(CorrelationID, String)

Exceptions

Exception	Condition
InvalidOperationException	Session is not started.

Remarks

This operation provides a convenience of passing a single CorrelationID. See Cancel(IListCorrelationID, String) operation for more information on the handling of cancel requests and other important notes.

Reference

AbstractSession Class

Cancel Overload

Bloomberglp.Blpapi Namespace

© BLOOMBERG L.P. MAKES NO WARRANTY, EXPRESS OR IMPLIED, AS TO RESULTS TO BE ATTAINED FROM THE USE OF THE SERVICES, FUNCTIONALITIES, OR DATA FROM AND OF THE BLOOMBERG API, OR EQUIPMENT BY WHICH THE SERVICES OR FUNCTIONS ARE PROVIDED, AND THERE ARE NO EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE.