Index.Script Method

Generates a Transact-SQL script that can be used to re-create the index.

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

Syntax

'Declaration
Public Function Script As StringCollection
'Usage
Dim instance As Index 
Dim returnValue As StringCollection 

returnValue = instance.Script()
public StringCollection Script()
public:
virtual StringCollection^ Script() sealed
abstract Script : unit -> StringCollection  
override Script : unit -> StringCollection
public final function Script() : StringCollection

Return Value

Type: System.Collections.Specialized.StringCollection
A StringCollection system object value that contains a list of Transact-SQL statements in the script.

Implements

IScriptable.Script()

Remarks

The generated script might contain undocumented, internal procedures, which are required for the complete script output.

Note

Indexes based partly on the UserDefinedTableType object do not support this method and running this method will generate an exception.

Examples

Scripting

See Also

Reference

Index Class

Script Overload

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Indexes

ALTER INDEX (Transact-SQL)