StoredProcedure.ScriptHeader Method

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
'Usage
Dim instance As StoredProcedure 
Dim forAlter As Boolean 
Dim returnValue As String 

returnValue = instance.ScriptHeader(forAlter)

public string ScriptHeader(
    bool forAlter
)

public:
virtual String^ ScriptHeader(
    bool forAlter
) sealed

abstract ScriptHeader : 
        forAlter:bool -> string  
override ScriptHeader : 
        forAlter:bool -> string

public final function ScriptHeader(
    forAlter : boolean
) : String

Parameters

• forAlter
  Type: System.Boolean
  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

Type: System.String
A String value that specifies the text header.

Implements

ITextObject.ScriptHeader(Boolean)

Examples

Creating, Altering, and Removing Stored Procedures

See Also

Reference

StoredProcedure Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

CREATE PROCEDURE (Transact-SQL)