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

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

value = instance.DdlHeaderOnly

instance.DdlHeaderOnly = value

public bool DdlHeaderOnly { get; set; }

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

member DdlHeaderOnly : bool with get, set

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

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

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

PowerShell

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

See Also

Reference

ScriptingOptions Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Scripting