DefaultRuleBase.ScriptHeader Method

Article
12/03/2008

Generates a Transact-SQL script that can be used to re-create the default or rule header as specified by the script options.

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

Syntax

'Declaration
Public Function ScriptHeader ( _
    forAlter As Boolean _
) As String

public string ScriptHeader (
    bool forAlter
)

public:
virtual String^ ScriptHeader (
    bool forAlter
) sealed

public final String ScriptHeader (
    boolean forAlter
)

public final function ScriptHeader (
    forAlter : boolean
) : String

Parameters

forAlter
A Boolean value that specifies whether the header can be altered.

If True, the header can be altered.

If False, the header cannot be altered.

Return Value

A StringCollection system object value that contains a list of Transact-SQL command batch statements that defines the default or rule header.

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