• Article

NotificationMessage Property

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 NotificationMessage property represents user-supplied text appended to any notification sent when a SQL Server Agent responds to an alert.

Syntax

object.NotificationMessage [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list

  • value
    A character string

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetNotificationMessage(SQLDMO_LPBSTR pRetVal);
HRESULT SetNotificationMessage(SQLDMO_LPCSTR NewValue);

Note

SQL Distributed Management Objects (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 using SysFreeString.

Remarks

When a Microsoft SQL Server alert is raised, SQL Server Agent builds a message and sends notifications as a response. The notification message is built with default parts and user-controlled parameters. To add user-specified text to an alert, set the NotificationMessage property of an Alert object.

Applies To:

Alert Object