MessageID Property (SQL-DMO)

The MessageID property identifies a Microsoft® SQL Server™ message to a SQL Server Agent alert.

Applies To

Syntax

object.MessageID [= value]

Part	Description
object	Expression that evaluates to an object in the Applies To list
value	Long integer identifier of a SQL Server system message

Remarks

A SQL Server Agent alert is raised when a SQL Server process raises 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 results in an error.

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.

Data Type

Long

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetMessageID(LPLONG pRetVal);

HRESULT SetMessageID(long NewValue);