ScriptingOptions.AppendToFile Property

  • Article

Gets or sets a Boolean property value that specifies whether the script is appended to the end of the output file or overwrites it.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Property AppendToFile As Boolean 
    Get 
    Set
'Usage
Dim instance As ScriptingOptions 
Dim value As Boolean 

value = instance.AppendToFile

instance.AppendToFile = value

public bool AppendToFile { get; set; }

public:
property bool AppendToFile {
    bool get ();
    void set (bool value);
}

member AppendToFile : bool with get, set

function get AppendToFile () : boolean 
function set AppendToFile (value : boolean)

Property Value

Type: System.Boolean
A Boolean value that specifies whether the generated script is appended to the end of the output file or overwrites it.If True, the generated script is appended to the end of the output file.If False (default), the generated script overwrites the existing contents of the output file.

Examples

The following code example specifies that the script overwrites or is appended to the end of the output file.

Visual Basic

Dim scOps As New ScriptingOptions()
scOps.AppendToFile = true

PowerShell

$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.AppendToFile = $TRUE

See Also

Reference

ScriptingOptions Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Scripting