• Article

Scripter.ScriptWithList Method (array<SqlSmoObject[])

Creates linear Transact-SQL scripts for an array of SqlSmoObject objects. 

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

Syntax

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

returnValue = instance.ScriptWithList(objects)

public StringCollection ScriptWithList(
    SqlSmoObject[] objects
)

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

member ScriptWithList : 
        objects:SqlSmoObject[] -> StringCollection 

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

Parameters

Return Value

Type: System.Collections.Specialized.StringCollection
A SqlSmoObject object array value that specifies the list of objects to be scripted.

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