DefaultRuleBase.ScriptHeader Method

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
'Usage
Dim instance As DefaultRuleBase 
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 header can be altered.If True, the header can be altered.If False, the header cannot be altered.

Return Value

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

Implements

ITextObject.ScriptHeader(Boolean)

Examples

Scripting

See Also

Reference

DefaultRuleBase Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Working with Database Objects

Rules

Defaults