Share via

ScriptingOptions.PrimaryObject Property

  • Article

Gets or sets the Boolean property value that specifies whether the creation of the referenced object is included in the generated script.

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

Syntax

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

value = instance.PrimaryObject

instance.PrimaryObject = value

public bool PrimaryObject { get; set; }

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

member PrimaryObject : bool with get, set

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

Property Value

Type: System.Boolean
A Boolean value that specifies whether the creation of the referenced object is included in the generated script.If true (default), the Transact-SQL CREATE statement for the referenced object is included in the generated script.If false, the Transact-SQL CREATE statement for the referenced object is not included in the generated script. The script only contains statements that modify the object.

Examples

The following code example specifies that the CREATE statement for the referenced object is scripted.

Visual Basic

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

PowerShell

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

See Also

Reference

ScriptingOptions Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Scripting