Share via

  • Article

Index.Script Method (ScriptingOptions)

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

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

Syntax

'Declaration
Public Function Script ( _
    scriptingOptions As ScriptingOptions _
) As StringCollection
'Usage
Dim instance As Index
Dim scriptingOptions As ScriptingOptions
Dim returnValue As StringCollection

returnValue = instance.Script(scriptingOptions)

public StringCollection Script(
    ScriptingOptions scriptingOptions
)

public:
virtual StringCollection^ Script(
    ScriptingOptions^ scriptingOptions
) sealed

abstract Script : 
        scriptingOptions:ScriptingOptions -> StringCollection 
override Script : 
        scriptingOptions:ScriptingOptions -> StringCollection 

public final function Script(
    scriptingOptions : ScriptingOptions
) : StringCollection

Parameters

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(ScriptingOptions)

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