• Article

ScriptNameObjectBase.GetTextHeader Method

Returns the text header.

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

Syntax

'Declaration
Protected Function GetTextHeader ( _
    forAlter As Boolean _
) As String
'Usage
Dim forAlter As Boolean
Dim returnValue As String

returnValue = Me.GetTextHeader(forAlter)

protected string GetTextHeader(
    bool forAlter
)

protected:
String^ GetTextHeader(
    bool forAlter
)

member GetTextHeader : 
        forAlter:bool -> string 

protected function GetTextHeader(
    forAlter : boolean
) : String

Parameters

  • forAlter
    Type: System.Boolean
    A Boolean value that specifies whether the text header is used in the alteration of an object.
    If True, the text header is used in the alteration of an object. Otherwise, False.

Return Value

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

Examples

Scripting