StoredProcedure.ScriptHeader Method

Article
12/03/2008

Returns the text header with the option to modify the text.

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 text header is read-only or can be modified.

If True, the text header can be modified.

If False, the text header is read-only.

Return Value

A String value that specifies the text header.

Remarks

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

Example

How to: Create, Alter, and Remove a Stored Procedure 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

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via