Share via


DocData.SaveDocData 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
Public Function SaveDocData ( _
    flags As VSSAVEFLAGS, _
    <OutAttribute> ByRef fileName As String, _
    <OutAttribute> ByRef saveCanceled As Integer _
) As Integer
public int SaveDocData(
    VSSAVEFLAGS flags,
    out string fileName,
    out int saveCanceled
)
public:
virtual int SaveDocData(
    VSSAVEFLAGS flags, 
    [OutAttribute] String^% fileName, 
    [OutAttribute] int% saveCanceled
) sealed
abstract SaveDocData : 
        flags:VSSAVEFLAGS * 
        fileName:string byref * 
        saveCanceled:int byref -> int  
override SaveDocData : 
        flags:VSSAVEFLAGS * 
        fileName:string byref * 
        saveCanceled:int byref -> int
public final function SaveDocData(
    flags : VSSAVEFLAGS, 
    fileName : String, 
    saveCanceled : int
) : 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.

Implements

IVsPersistDocData2.SaveDocData(VSSAVEFLAGS, String%, Int32%)
IVsPersistDocData.SaveDocData(VSSAVEFLAGS, String%, Int32%)

Remarks

This method is typically used with the Save As option.

This method implements the IVsPersistDocData2 interface.

.NET Framework Security

See Also

Reference

DocData Class

Microsoft.VisualStudio.Modeling.Shell Namespace