IVsQueryEditQuerySave2.BeginQuerySaveBatch Method
Creates a batch of a sequence of documents before attempting to save them to disk.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Function BeginQuerySaveBatch As Integer
'Usage
Dim instance As IVsQueryEditQuerySave2
Dim returnValue As Integer
returnValue = instance.BeginQuerySaveBatch()
int BeginQuerySaveBatch()
int BeginQuerySaveBatch()
function BeginQuerySaveBatch() : 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 ivsqueryeditquerysave2.idl
HRESULT BeginQuerySaveBatch();
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 user interface (UI) for those calls. Batching these calls using the BeginQuerySaveBatch and EndQuerySaveBatch method increases the likelihood that the environment will display only one piece of UI; however, this is not guaranteed.
For example, when the caller batches QuerySaves, each individual (that is, not batched) save operation message box has a Cancel button. If Cancel is clicked, the operation is applied to future QuerySave calls until there are no more batched files to be processed.
For batched QuerySave 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.
See Also
Reference
IVsQueryEditQuerySave2 Interface