Dela via


Alert.MessageID Property

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
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property MessageID As Integer
    Get
    Set
'Usage
Dim instance As Alert
Dim value As Integer

value = instance.MessageID

instance.MessageID = value
[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public int MessageID { get; set; }
[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property int MessageID {
    int get ();
    void set (int value);
}
[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member MessageID : int with get, set
function get MessageID () : int
function set MessageID (value : int)

Property Value

Type: System.Int32
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.