• Article

ScriptingOptions.AgentJobId Property

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

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

Syntax

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

value = instance.AgentJobId

instance.AgentJobId = value

public bool AgentJobId { get; set; }

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

member AgentJobId : bool with get, set

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

Property Value

Type: System.Boolean
A Boolean value that specifies whether to include SQL Server Agent job ID values in the script.
If True, the job ID is scripted. Otherwise, False (default).

Examples

The following code example specifies that the job ID will be scripted.

Visual Basic

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

PowerShell

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