Share via


ITextDocument.SaveCopy Method (String, Boolean, Boolean)

Saves the contents of the TextBuffer to the specified file path.

Namespace:  Microsoft.VisualStudio.Text
Assembly:  Microsoft.VisualStudio.Text.Data (in Microsoft.VisualStudio.Text.Data.dll)

Syntax

'Declaration
Sub SaveCopy ( _
    filePath As String, _
    overwrite As Boolean, _
    createFolder As Boolean _
)
void SaveCopy(
    string filePath,
    bool overwrite,
    bool createFolder
)
void SaveCopy(
    String^ filePath, 
    bool overwrite, 
    bool createFolder
)
abstract SaveCopy : 
        filePath:string * 
        overwrite:bool * 
        createFolder:bool -> unit
function SaveCopy(
    filePath : String, 
    overwrite : boolean, 
    createFolder : boolean
)

Parameters

  • overwrite
    Type: System.Boolean

    true if filePath should be overwritten if it exists, otherwise false.

  • createFolder
    Type: System.Boolean

    true if the folder containing filePath should be created if it does not exist, otherwise false.

Exceptions

Exception Condition
ArgumentNullException

filePath is nulla null reference (Nothing in Visual Basic).

UnauthorizedAccessException

An access error occurred during file save.

IOException

An I/O error occurred (including an error caused by attempting to overwrite an existing file when overwrite is false).

ObjectDisposedException

This object has been disposed.

Remarks

This call does not affect the IsDirty, LastSavedTime, and FilePath properties.

The FileActionOccurred event is not raised.

.NET Framework Security

See Also

Reference

ITextDocument Interface

SaveCopy Overload

Microsoft.VisualStudio.Text Namespace