This topic has not yet been rated - Rate this topic

ScriptingOptions.DdlHeaderOnly Property

Gets or sets the Boolean property value that specifies whether to script only the header information for data definition language (DDL) objects that have a text body, such as stored procedures and triggers.

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

Syntax

C++

JScript

Copy


public bool DdlHeaderOnly { get; set; }

Property Value

Type: System.Boolean
A Boolean value that specifies whether to script only the header information.If True, only the header information of the object is scripted.If False (default), the object is scripted completely.

Remarks

The DdlHeaderOnly property applies only to objects with a text body containing a Transact-SQL statement that defines the object.

Examples

The following code example specifies that only the header information of any DDL objects will be scripted.

Visual Basic

Copy

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

PowerShell

Copy

$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.DdlHeaderOnly = $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