IVsRunningDocumentTable.SaveDocuments Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Saves the documents.

public:
 int SaveDocuments(System::UInt32 grfSaveOpts, Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHier, System::UInt32 itemid, System::UInt32 docCookie);

public:
 int SaveDocuments(unsigned int grfSaveOpts, Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHier, unsigned int itemid, unsigned int docCookie);

int SaveDocuments(unsigned int grfSaveOpts, Microsoft::VisualStudio::Shell::Interop::IVsHierarchy const & pHier, unsigned int itemid, unsigned int docCookie);

public int SaveDocuments (uint grfSaveOpts, Microsoft.VisualStudio.Shell.Interop.IVsHierarchy pHier, uint itemid, uint docCookie);

abstract member SaveDocuments : uint32 * Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * uint32 -> int

Public Function SaveDocuments (grfSaveOpts As UInteger, pHier As IVsHierarchy, itemid As UInteger, docCookie As UInteger) As Integer

Parameters

grfSaveOpts

UInt32

[in] Save options whose values are taken from the __VSRDTSAVEOPTIONS enumeration.

pHier

IVsHierarchy

[in] The IVsHierarchy interface that owns the document.

itemid

UInt32

[in] Item identifier of the saved documents. This is a unique identifier or it can be one of the following values: VSITEMID_NIL, VSITEMID_ROOT, or VSITEMID_SELECTION.

docCookie

UInt32

[in] Abstract value representing the saved documents.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsRunningDocumentTable::SaveDocuments(  
   [in] VSRDTSAVEOPTIONS  grfSaveOpts,  
   [in] IVsHierarchy     *pHier,  
   [in] VSITEMID          itemid,  
   [in] VSCOOKIE          docCookie  
);  

The docCookie parameter is same value that is returned from the FindAndLockDocument or RegisterAndLockDocument methods.