DdlHeaderOnly Property
Collapse the table of content
Expand the table of content

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)

property bool DdlHeaderOnly {
	bool get();
	void set(bool value);

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.

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

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

Visual Basic

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


$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.DdlHeaderOnly = $TRUE
Return to top
© 2016 Microsoft