This topic has not yet been rated - Rate this topic

ScriptingOptions.IncludeHeaders Property

Gets or sets a Boolean property value that specifies whether the generated script is prefixed with a header that contains information which includes the date and time of generation.

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

Syntax

C++

JScript

Copy


public bool IncludeHeaders { get; set; }

Property Value

Type: System.Boolean
A Boolean value that specifies whether to include header information at the start of the generated script.If True, header information is included. Otherwise, False (default).

Examples

The following code example specifies that the script will be prefixed with a header.

Visual Basic

Copy

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

PowerShell

Copy

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