IVsRunningDocumentTable.SaveDocuments Method

Article
05/06/2010

Determines the save options used to save documents.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Déclaration
Function SaveDocuments ( _
    grfSaveOpts As UInteger, _
    pHier As IVsHierarchy, _
    itemid As UInteger, _
    docCookie As UInteger _
) As Integer
'Utilisation
Dim instance As IVsRunningDocumentTable
Dim grfSaveOpts As UInteger
Dim pHier As IVsHierarchy
Dim itemid As UInteger
Dim docCookie As UInteger
Dim returnValue As Integer

returnValue = instance.SaveDocuments(grfSaveOpts, _
    pHier, itemid, docCookie)

int SaveDocuments(
    uint grfSaveOpts,
    IVsHierarchy pHier,
    uint itemid,
    uint docCookie
)

int SaveDocuments(
    [InAttribute] unsigned int grfSaveOpts, 
    [InAttribute] IVsHierarchy^ pHier, 
    [InAttribute] unsigned int itemid, 
    [InAttribute] unsigned int docCookie
)

abstract SaveDocuments : 
        grfSaveOpts:uint32 * 
        pHier:IVsHierarchy * 
        itemid:uint32 * 
        docCookie:uint32 -> int

function SaveDocuments(
    grfSaveOpts : uint, 
    pHier : IVsHierarchy, 
    itemid : uint, 
    docCookie : uint
) : int

Parameters

grfSaveOpts
Type: System.UInt32
[in] Save options whose values are taken from the __VSRDTSAVEOPTIONS enumeration.

pHier
Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy
[in] The IVsHierarchy interface that owns the document.

itemid
Type: System.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
Type: System.UInt32
[in] Abstract value representing the saved documents.

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 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.

.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.

Partager via