Alert.MessageID Property

Article
12/03/2008

Gets or sets the ID value of the Microsoft SQL Server message that causes the alert to be raised.

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

Syntax

'Declaration
Public Property MessageID As Integer

public int MessageID { get; set; }

public:
property int MessageID {
    int get ();
    void set (int value);
}

/** @property */
public int get_MessageID ()

/** @property */
public void set_MessageID (int value)

public function get MessageID () : int

public function set MessageID (value : int)

Property Value

An Int32 value that specifies the ID value of the message that causes the alert to be raised.

Remarks

A SQL Server Agent alert is raised when a SQL Server process causes a specific error or an error of a specific severity. Setting the MessageID property of an Alert object associates an alert with a specific SQL Server system error message.

Setting both the MessageID and Severity properties of an Alert object attempts to associate an alert with both an error message and an error message severity level, which causes an exception.

SQL Server Agent alerts based on the MessageID property can be restricted to a specific database. Use the MessageID and DatabaseName properties of the Alert object to restrict alert activation.

Multiple alerts can be defined for a single error message, but each alert defined on the error message must be restricted to a specific database.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.

Example

How to: Create an Alert in Visual Basic .NET

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms