• Article

Job.Category Property

Gets or sets the category to which the job belongs.

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

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.None Or SfcPropertyFlags.Expensive Or SfcPropertyFlags.Standalone)> _
Public Property Category As String
    Get
    Set
'Usage
Dim instance As Job
Dim value As String

value = instance.Category

instance.Category = value

[SfcPropertyAttribute(SfcPropertyFlags.None|SfcPropertyFlags.Expensive|SfcPropertyFlags.Standalone)]
public string Category { get; set; }

[SfcPropertyAttribute(SfcPropertyFlags::None|SfcPropertyFlags::Expensive|SfcPropertyFlags::Standalone)]
public:
property String^ Category {
    String^ get ();
    void set (String^ value);
}

[<SfcPropertyAttribute(SfcPropertyFlags.None|SfcPropertyFlags.Expensive|SfcPropertyFlags.Standalone)>]
member Category : string with get, set

function get Category () : String
function set Category (value : String)

Property Value

Type: System.String
A String value that specifies the category to which the job belongs.

Remarks

When setting the property for a Job object, the value must reference an existing Microsoft SQL Server Agent job category.

SQL Server job categories group SQL Server Agent objects into user-defined categories. The Category property of Job objects references the applicable SQL Server Agent job category.

By setting the Category property for the JobFilter object you can restrict the results of the EnumJobs method of the JobServer object to SQL Server Agent jobs with the specified job category.

Examples

The following code example specifies that the job belongs to the "Data Collector" category.

C#

Job jb = new Job();
jb.Category = "Data Collector";

PowerShell

$jb = new-object Microsoft.SqlServer.Management.Smo.Agent.Job
$jb.Category = "Data Collector";