Share via

  • Article

Job.IsEnabled Property

Gets or sets the Boolean property value that specifies whether the job is enabled.

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

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property IsEnabled As Boolean
    Get
    Set
'Usage
Dim instance As Job
Dim value As Boolean

value = instance.IsEnabled

instance.IsEnabled = value

[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public bool IsEnabled { get; set; }

[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property bool IsEnabled {
    bool get ();
    void set (bool value);
}

[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member IsEnabled : bool with get, set

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

Property Value

Type: System.Boolean
A Boolean value that specifies whether the job is enabled or not.
If True, the job is enabled.
If False (default), the job is not enabled.

Remarks

Setting the IsEnabled property of a Job object to False disables a Microsoft SQL Server Agent job. A disabled job does not run.

Examples

The following code example declares and enables a job.

C#

Server srv = new Server("(local)");
Job jb = new Job(srv.JobServer, "Test Job");
jb.IsEnabled = true;

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$jb = new-object Microsoft.SqlServer.Management.Smo.Agent.Job($srv.JobServer, "Test Job")
$jb.IsEnabled = $TRUE