ScriptingOptions.ClusteredIndexes Property

  • Article

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

public bool ClusteredIndexes { get; set; }

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

/** @property */
public boolean get_ClusteredIndexes ()

/** @property */
public void set_ClusteredIndexes (boolean value)

public function get ClusteredIndexes () : boolean

public function set ClusteredIndexes (value : boolean)

Property Value

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. If False (default), clustered indexes are not included in the script.

Remarks

This property applies only when scripting a SQL Server table.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

ScriptingOptions Class
ScriptingOptions Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

How to: Script Out the Dependencies for a Database in Visual Basic .NET
Scripting