The IncludeEventDescription property indicates response notifications that receive alert error text when SQL Server Agent builds a notification message for an alert.
object.IncludeEventDescription [= value]
Part | Description |
---|---|
object | Expression that evaluates to an object in the Applies To list |
value | Long integer specifying the a response type as described in Settings |
Constant | Value | Description |
---|---|---|
SQLDMONotify_All | 7 | Always include the alert error text regardless of the notification method used |
SQLDMONotify_Email | 1 | Include the alert error text when notifying by e-mail sent to the operator e-mail address |
SQLDMONotify_NetSend | 4 | Include the alert error text when notifying by network popup message posted to the operator network address |
SQLDMONotify_None | 0 | Do not include alert error text in any notification attempt |
SQLDMONotify_Pager | 2 | Include the alert error text when notifying by e-mail sent to the operator pager address |
SQL Server Agent builds a notification message to send in response to a raised alert. For each notification method (e-mail, pager, or net send), SQL 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.
Long, enumerated
Read/write
HRESULT GetIncludeEventDescription(SQLDMO_NOTIFY_TYPE *pRetVal);
HRESULT SetIncludeEventDescription(SQLDMO_NOTIFY_TYPE NewValue);
Notification Method Constants (SQLDMO_NOTIFY_TYPE) | NotificationMessage Property |