• Article

ScriptingOptions.AllowSystemObjects Property

Gets or sets the Boolean property that specifies whether system objects can be scripted.

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

Syntax

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

value = instance.AllowSystemObjects

instance.AllowSystemObjects = value

public bool AllowSystemObjects { get; set; }

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

member AllowSystemObjects : bool with get, set

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

Property Value

Type: System.Boolean
A Boolean value that specifies whether system objects can be scripted.
If True, system objects are included in the script. Otherwise, False (default).

Examples

The following code example specifies that system objects will be scripted.

Visual Basic

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

PowerShell

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