Share via

ScriptingOptions.IncludeDatabaseContext Property

  • Article

Gets or sets the Boolean property value that specifies whether database context is included in the generated script.

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

Syntax

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

value = instance.IncludeDatabaseContext

instance.IncludeDatabaseContext = value

public bool IncludeDatabaseContext { get; set; }

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

member IncludeDatabaseContext : bool with get, set

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

Property Value

Type: System.Boolean
A Boolean value that specifies whether database context is included in the generated script.If True, database context are included in the generated script. Otherwise, False (default).

Examples

The following code example specifies that database context information will be scripted.

Visual Basic

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

PowerShell

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

See Also

Reference

ScriptingOptions Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Scripting