IVsTrackProjectDocumentsEvents3.OnEndQueryBatch Method
Determines whether it is okay to proceed with the actual batch operation after successful completion of a batch query process.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)
Syntax
'Declaration
Function OnEndQueryBatch ( _
<OutAttribute> ByRef pfActionOK As Integer _
) As Integer
int OnEndQueryBatch(
out int pfActionOK
)
int OnEndQueryBatch(
[OutAttribute] int% pfActionOK
)
abstract OnEndQueryBatch :
pfActionOK:int byref -> int
function OnEndQueryBatch(
pfActionOK : int
) : int
Parameters
- pfActionOK
Type: System.Int32%
[out] Returns nonzero if it is okay to continue with the proposed batch process. Returns zero if the proposed batch process should not proceed.
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
);
This method is called as a result of a call to the EndQueryBatch method.
If any query in a project's batch query process results in an error, the project calls the CancelQueryBatch method, which in turn calls the OnCancelQueryBatch method. However, if all queries succeed, the project calls the OnEndQueryBatch method. If this method has any reason to cancel any subsequent batch operation, it signals the caller by returning 0 for pfActionOK. This could be a result of presenting a dialog box (in which the user canceled the batch operation) or some internal determination as a result of all the queries made.
For every call to this method, there must have been a previous call to the OnBeginQueryBatch method.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.