IncludeEventDescription 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 IncludeEventDescription property indicates response notifications that receive alert error text when a SQL Server Agent builds a notification message for an alert.
Syntax
object.IncludeEventDescription [=value]
Parts
object
An expression that evaluates to an object in the Applies To list.value
A long integer that specifies a response type as described in Settings.
Settings
Constant |
Value |
Description |
|---|---|---|
SQLDMONotify_All |
7 |
Notification is made by e-mail sent to the pager address and by a network pop-up message. |
SQLDMONotify_Email |
1 |
Notification is made by e-mail sent to the operator e-mail address. |
SQLDMONotify_NetSend |
4 |
Notification is made by net send message posted to the operator network address. |
SQLDMONotify_None |
0 |
No notification method is specified for the referenced operator. |
SQLDMONotify_Pager |
2 |
Notification is made by e-mail sent to the operator pager address. |
Data Type
Long, enumerated
Modifiable
Read/write
Prototype (C/C++)
HRESULT GetIncludeEventDescription(SQLDMO_NOTIFY_TYPE *pRetVal);
HRESULT SetIncludeEventDescription(SQLDMO_NOTIFY_TYPE NewValue);
Remarks
SQL Server Agent builds a notification message to send in response to a raised alert. For each notification method (e-mail, pager, or net sendSQL Server Agent can build a different message. To include alert error text in a SQL Server Agent-built message, set the IncludeEventDescription property of the referring Alert object.
To specify that more than one notification method should include error text, combine values by using an OR logical operator.