Share via

  • Article

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

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

value = instance.IncludeHeaders

instance.IncludeHeaders = value

public bool IncludeHeaders { get; set; }

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

member IncludeHeaders : bool with get, set

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

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

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

PowerShell

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