IVsTrackProjectDocuments3.EndQueryBatch(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Indicates that a batched query process has been completed and determines whether or not the batched operations should be allowed to proceed.

public:
 int EndQueryBatch([Runtime::InteropServices::Out] int % pfActionOK);

int EndQueryBatch([Runtime::InteropServices::Out] int & pfActionOK);

public int EndQueryBatch (out int pfActionOK);

abstract member EndQueryBatch : int -> int

Public Function EndQueryBatch (ByRef pfActionOK As Integer) As Integer

Parameters

pfActionOK: Int32

[out] Returns nonzero if it is okay to proceed with the batched operations. Returns 0 if the batched operations should not occur.

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 OnEndQueryBatch(  
   [out, retval] BOOL *pfActionOK  
);

After the project calls the BeginQueryBatch method, the project makes a series of calls to the OnQueryXX methods on the IVsTrackProjectDocuments2 interface. When all queries have been completed, EndQueryBatch summarizes the results of all those queries and returns nonzero to indicate that it is okay to proceed with the requested operations. EndQueryBatch might ask the user for confirmation, in which case only the single dialog box is presented for the entire batch process.

Each call to this method must be matched with a previous call to the BeginQueryBatch method.

Applies to

Share via