Category Property (SQL-DMO)

The Category property represents the name of a category for SQL Server Agent alerts, jobs, and operators.

Applies To
Alert Object JobFilter Object
Job Object Operator Object

Syntax

object.Category [= value]

Part Description
object Expression that evaluates to an object in the Applies To list.
value Specifies an existing SQL Server Agent category by name. A SQL Server Agent category name can contain up to 100 characters.

Remarks

Microsoft® SQL Server™ alert, job, and operator categories group SQL Server Agent objects. The Category property of SQL-DMO Alert, Job, and Operator objects references the applicable SQL Server Agent category.

Setting the Category property for the JobFilter object restricts listed SQL Server Agent jobs to those having the category when using the EnumJobs method of the JobServer object.

Data Type

String

Modifiable

Read/write. When setting the property for an Alert, Job, or Operator object, the value must reference an existing SQL Server Agent alert, job, or operator category.

Prototype (C/C++)

HRESULT GetCategory(SQLDMO_LPBSTR pRetVal);

HRESULT SetCategory(SQLDMO_LPCSTR NewVal);


Note SQL-DMO strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference by using SysFreeString.


  


(c) 1988-98 Microsoft Corporation. All Rights Reserved.