Share via

ScriptingOptions.AgentAlertJob Property

  • Article

Gets or sets the Boolean property that specifies whether to include SQL Server Agent job name for alert objects in the script.

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

Syntax

'Declaration
Public Property AgentAlertJob As Boolean 
    Get 
    Set
'Usage
Dim instance As ScriptingOptions 
Dim value As Boolean 

value = instance.AgentAlertJob

instance.AgentAlertJob = value

public bool AgentAlertJob { get; set; }

public:
property bool AgentAlertJob {
    bool get ();
    void set (bool value);
}

member AgentAlertJob : bool with get, set

function get AgentAlertJob () : boolean 
function set AgentAlertJob (value : boolean)

Property Value

Type: System.Boolean
A Boolean value that specifies whether to include SQL Server Agent alerts and jobs.If True, alerts and jobs are scripted. Otherwise, False (default).

Examples

The following code example specifies that alerts and jobs will be scripted.

Visual Basic

Dim scOps As New ScriptingOptions()
scOps.AgentAlertJob = true

PowerShell

$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.AgentAlertJob = $TRUE

See Also

Reference

ScriptingOptions Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Scripting