IVsTrackProjectDocuments3.EndQueryBatch Method

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

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

Syntax

'Declaration
Function EndQueryBatch ( _
    <OutAttribute> ByRef pfActionOK As Integer _
) As Integer
int EndQueryBatch(
    out int pfActionOK
)
int EndQueryBatch(
    [OutAttribute] int% pfActionOK
)
abstract EndQueryBatch : 
        pfActionOK:int byref -> int 
function EndQueryBatch(
    pfActionOK : int
) : int

Parameters

  • pfActionOK
    Type: System.Int32%
    [out] Returns nonzero if it is okay to proceed with the batched operations. Returns 0 if the batched operations should not occur.

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 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.

.NET Framework Security

See Also

Reference

IVsTrackProjectDocuments3 Interface

Microsoft.VisualStudio.Shell.Interop Namespace