IVsTrackProjectDocumentsEvents3.OnCancelQueryBatch Method

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

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function OnCancelQueryBatch As Integer
int OnCancelQueryBatch()
int OnCancelQueryBatch()
abstract OnCancelQueryBatch : unit -> int 
function OnCancelQueryBatch() : int

Return Value

Type: System.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.

.NET Framework Security

See Also

Reference

IVsTrackProjectDocumentsEvents3 Interface

Microsoft.VisualStudio.Shell.Interop Namespace