Scripter.Script Method (array<SqlSmoObject )

Generates Transact-SQL scripts that can be used to re-create a list of objects.

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

Syntax

'Declaration
Public Function Script ( _
    objects As SqlSmoObject() _
) As StringCollection
'Usage
Dim instance As Scripter 
Dim objects As SqlSmoObject()
Dim returnValue As StringCollection 

returnValue = instance.Script(objects)

public StringCollection Script(
    SqlSmoObject[] objects
)

public:
StringCollection^ Script(
    array<SqlSmoObject^>^ objects
)

member Script : 
        objects:SqlSmoObject[] -> StringCollection

public function Script(
    objects : SqlSmoObject[]
) : StringCollection

Parameters

• objects
  Type: array<Microsoft.SqlServer.Management.Smo.SqlSmoObject[]
  A SqlSmoObject object array value that specifies the list of objects to be scripted.

Return Value

Type: System.Collections.Specialized.StringCollection
A StringCollection object value that specifies the Transact-SQL scripts for the list of objects.

Remarks

This method throws an exception if it is invoked when the ScriptData property is set to true. This prevents the entire dataset from being scripted to a StringCollection object.

Examples

Scripting

See Also

Reference

Scripter Class

Script Overload

Microsoft.SqlServer.Management.Smo Namespace