IVsQueryEditQuerySave2.EndQuerySaveBatch Method
Ends the batch started by the BeginQuerySaveBatch method and displays any user interface (UI) generated within the batch.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Function EndQuerySaveBatch As Integer
int EndQuerySaveBatch()
int EndQuerySaveBatch()
abstract EndQuerySaveBatch : unit -> int
function EndQuerySaveBatch() : int
Return Value
Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
Remarks
COM Signature
From ivsqueryeditquerysave2.idl
HRESULT EndQuerySaveBatch();
This method is a hint to the environment that you are going to call several QuerySave operations (QuerySaveFile or QuerySaveFiles), and that you would like the user to receive only one piece of UI for those calls. Batching these calls using the BeginQuerySaveBatch method and EndQuerySaveBatch increases the likelihood that the environment will only display one piece of UI; however, this is not guaranteed.
For example, when batching calls to QuerySaveFile or QuerySaveFiles, each individual (that is, not batched) save operation message box has a Cancel button. If Cancel is clicked, the operation is applied to future QuerySaveXX calls until there are no more batched files to be processed.
For batched QuerySaveXX operations, a call to EndQuerySaveBatch ends the batch. If the user cancels the operation, you will not prompt further until the batch operation is complete.
.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.