ScriptingOptions.ClusteredIndexes Property
Gets or sets a Boolean property value that specifies whether statements that define clustered indexes are included in the generated script.
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public Property ClusteredIndexes As Boolean
Get
Set
'Usage
Dim instance As ScriptingOptions
Dim value As Boolean
value = instance.ClusteredIndexes
instance.ClusteredIndexes = value
public bool ClusteredIndexes { get; set; }
public:
property bool ClusteredIndexes {
bool get ();
void set (bool value);
}
member ClusteredIndexes : bool with get, set
function get ClusteredIndexes () : boolean
function set ClusteredIndexes (value : boolean)
Property Value
Type: System.Boolean
A Boolean value that specifies whether statements that define clustered indexes are included in the generated script.
If True, clustered indexes are included in the script. Otherwise, False (default).
Remarks
This property applies only when scripting a SQL Server table.
Examples
The following code example specifies that statements defining clustered indexes are included in the script.
Visual Basic
Dim scOps As New ScriptingOptions()
scOps.ClusteredIndexes = true
PowerShell
$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.ClusteredIndexes = $TRUE
See Also