This topic has not yet been rated - Rate this topic

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

C++

JScript

Copy


public bool ToFileOnly { get; set; }

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

Copy

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

PowerShell

Copy

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

Reference

ScriptingOptions Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Scripting

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ