EnumAlerts Method

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The EnumAlerts method returns a QueryResults object that enumerates the Microsoft SQL Server Agent alerts that cause automated execution of the referenced job.

Syntax

object
.EnumAlerts( )
as 
QueryResults

Parts

  • object
    Expression that evaluates to an object in the Applies To list.

Returns

A QueryResults object that contains one result set defined by these columns.

Column

Data type

Description

enabled

tinyint

When 1, the alert is enabled.

id

integer

System-generated alert identifier.

name

nvarchar(129)

Alert name.

type

integer

Identifies the alert source as described in Remarks.

Prototype (C/C++)

HRESULT EnumAlerts(LPSQLDMOQUERYRESULTS* ppResults);

Remarks

The result set column type identifies the alert source. When 1, the alert is raised in response to a SQL Server event. When 2, the alert is raised when a monitored performance condition is exceeded.

Applies To: