DocData.SaveDocDataToFile Method

Saves the document to a specific location.

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Syntax

'Declaration
Protected Overridable Function SaveDocDataToFile ( _
    saveOptions As VSSAVEFLAGS, _
    <OutAttribute> ByRef fileName As String, _
    <OutAttribute> ByRef saveCanceled As Integer, _
    uiShell As IVsUIShell _
) As Integer
protected virtual int SaveDocDataToFile(
    VSSAVEFLAGS saveOptions,
    out string fileName,
    out int saveCanceled,
    IVsUIShell uiShell
)
protected:
virtual int SaveDocDataToFile(
    VSSAVEFLAGS saveOptions, 
    [OutAttribute] String^% fileName, 
    [OutAttribute] int% saveCanceled, 
    IVsUIShell^ uiShell
)
abstract SaveDocDataToFile : 
        saveOptions:VSSAVEFLAGS * 
        fileName:string byref * 
        saveCanceled:int byref * 
        uiShell:IVsUIShell -> int  
override SaveDocDataToFile : 
        saveOptions:VSSAVEFLAGS * 
        fileName:string byref * 
        saveCanceled:int byref * 
        uiShell:IVsUIShell -> int
protected function SaveDocDataToFile(
    saveOptions : VSSAVEFLAGS, 
    fileName : String, 
    saveCanceled : int, 
    uiShell : IVsUIShell
) : int

Parameters

  • fileName
    Type: String%

    The file name of the document.

  • saveCanceled
    Type: Int32%

    1 if the save was canceled; otherwise, 0.

Return Value

Type: Int32
S_OK if the method succeeds; otherwise, it returns an error code.

.NET Framework Security

See Also

Reference

DocData Class

Microsoft.VisualStudio.Modeling.Shell Namespace