IVsAsyncRunningDocumentTable.SaveDocumentsAsync Method
Definition
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.
Saves one or more documents asynchronously.
public Microsoft.VisualStudio.Shell.Interop.IVsTask SaveDocumentsAsync (uint saveOpts, Microsoft.VisualStudio.Shell.Interop.IVsHierarchy? hierarchy, uint itemid, uint docCookie, Microsoft.VisualStudio.Shell.Interop.IVsProgress? progress);abstract member SaveDocumentsAsync : uint32 * Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * uint32 * Microsoft.VisualStudio.Shell.Interop.IVsProgress -> Microsoft.VisualStudio.Shell.Interop.IVsTaskPublic Function SaveDocumentsAsync (saveOpts As UInteger, hierarchy As IVsHierarchy, itemid As UInteger, docCookie As UInteger, progress As IVsProgress) As IVsTaskParameters
- saveOpts
- UInt32
The save options
- hierarchy
- IVsHierarchy
The hierarchy that owns the document to save, or null. This
parameter is only used if docCookie is VSCOOKIE_NIL
and itemid is not VSITEMID_SELECTION. In that case,
if this parameter is non-null, then the document identified by
itemid is saved.
- itemid
- UInt32
The item identifier for the document to save, or VSITEMID_SELECTION.
This parameter is only used if docCookie is VSCOOKIE_NIL.
In that case, if this value is VSITEMID_SELECTION then all selected documents
are saved. If this value is not VSITEMID_SELECTION and hierarchy
is non-null, this value must be something other than VSITEMID_NIL.
- docCookie
- UInt32
The cookie for the document, or VSCOOKIE_NIL. If this parameter is not
VSCOOKIE_NIL, hierarchy and itemid are
ignored and the document identified by the cookie is saved.
- progress
- IVsProgress
The interface through which progress is reported.
Returns
A task representing the asynchronous operation
Remarks
If docCookie is VSCOOKIE_NIL, itemid is not VSITEMID_SELECTION, and hierarchy is null, all dirty documents are saved.
This method is safe to access from any thread.