ScriptingOptions.ToFileOnly Property

Gets or sets the Boolean property value that specifies whether to output to file only or to also generate string output.

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

Syntax

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

value = instance.ToFileOnly

instance.ToFileOnly = value
public bool ToFileOnly { get; set; }
public:
property bool ToFileOnly {
    bool get ();
    void set (bool value);
}
member ToFileOnly : bool with get, set
function get ToFileOnly () : boolean
function set ToFileOnly (value : boolean)

Property Value

Type: System.Boolean
A Boolean value that specifies whether to output to file only or to also generate string output.
If True, the generated script is output to file only. Otherwise, False (default).

Remarks

Specify this option whenever string output is not required, because scripting dependencies can potentially yield a very large string.

Examples

The following code example specifies that output will be written to a file only. No string output will be generated.

Visual Basic

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

PowerShell

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