ScriptNameObjectBase.GetTextForScript Method

Article
12/03/2008

Gets the text for scripting.

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

Syntax

'Declaration
Protected Function GetTextForScript ( _
    so As ScriptingOptions, _
    forCreate As Boolean, _
    expectedObjectTypes As String() _
) As String

protected string GetTextForScript (
    ScriptingOptions so,
    bool forCreate,
    string[] expectedObjectTypes
)

protected:
String^ GetTextForScript (
    ScriptingOptions^ so, 
    bool forCreate, 
    array<String^>^ expectedObjectTypes
)

protected String GetTextForScript (
    ScriptingOptions so, 
    boolean forCreate, 
    String[] expectedObjectTypes
)

protected function GetTextForScript (
    so : ScriptingOptions, 
    forCreate : boolean, 
    expectedObjectTypes : String[]
) : String

Parameters

so
A ScriptingOptions object value that specifies the scripting options used for scripting the text.

forCreate
A Boolean value that specifies whether the text is used in the creation of an object.

If True, the text is used for the creation of an object.

If False, the text is not used for creation.

expectedObjectTypes
A String array that specifies the expected object types.

Return Value

A String value that specifies the text for scripting.

Remarks

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

Example

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

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