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)

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

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).

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
Return to top
Show: