• Article

ITextObject.ScriptHeader Method

Scripts the text header.

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

Syntax

'Declaration
Function ScriptHeader ( _
    forAlter As Boolean _
) As String
'Usage
Dim instance As ITextObject
Dim forAlter As Boolean
Dim returnValue As String

returnValue = instance.ScriptHeader(forAlter)

string ScriptHeader(
    bool forAlter
)

String^ ScriptHeader(
    bool forAlter
)

abstract ScriptHeader : 
        forAlter:bool -> string 

function ScriptHeader(
    forAlter : boolean
) : String

Parameters

  • forAlter
    Type: System.Boolean
    A Boolean value that specifies whether to create an alter script header.
    If True, an alter script is generated.
    If False, a create script is generated.

Return Value

Type: System.String
Returns String that specifies the text header.