• Article

ScriptingOptions.IncludeIfNotExists Property

Gets or sets a Boolean property value that specifies whether to check the existence of an object before including it in the script.

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

Syntax

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

value = instance.IncludeIfNotExists

instance.IncludeIfNotExists = value

public bool IncludeIfNotExists { get; set; }

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

member IncludeIfNotExists : bool with get, set

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

Property Value

Type: System.Boolean
A Boolean value that specifies whether to check the existence of an object before including it in the script.
If True, the existence of an object is verified before including it in the script. Otherwise, False (default).

Remarks

Creation script for the object is generated only when it does not already exist.

Examples

The following code example specifies that the script will verify the existence of an object before including it in the script.

Visual Basic

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

PowerShell

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