IVsTrackProjectDocumentsEvents3.OnCancelQueryBatch Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

This method is called to indicate that a batch query process has been canceled.

public:
 int OnCancelQueryBatch();

public:
 int OnCancelQueryBatch();

int OnCancelQueryBatch();

public int OnCancelQueryBatch ();

abstract member OnCancelQueryBatch : unit -> int

Public Function OnCancelQueryBatch () As Integer

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From ivstrackprojectdocumentsevents80.idl

HRESULT OnCancelQueryBatch(void);  

This method is called as a result of a call to the CancelQueryBatch method.

If a project determines that a batch process cannot proceed, it calls this method to indicate that the process is canceled. This method should do whatever is necessary to clean up what might have been done in the OnBeginQueryBatch method.

For every call to this method, a previous call to the OnBeginQueryBatch method must have been made.