Alert.IncludeEventDescription Property
Gets or sets the NotifyMethods object value that specifies the types of notification methods (e-mail, pager, or net send) that can contain alert error text.
Namespace: Microsoft.SqlServer.Management.Smo.Agent
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property IncludeEventDescription As NotifyMethods
Get
Set
'Usage
Dim instance As Alert
Dim value As NotifyMethods
value = instance.IncludeEventDescription
instance.IncludeEventDescription = value
[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public NotifyMethods IncludeEventDescription { get; set; }
[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property NotifyMethods IncludeEventDescription {
NotifyMethods get ();
void set (NotifyMethods value);
}
[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member IncludeEventDescription : NotifyMethods with get, set
function get IncludeEventDescription () : NotifyMethods
function set IncludeEventDescription (value : NotifyMethods)
Property Value
Type: Microsoft.SqlServer.Management.Smo.Agent.NotifyMethods
A NotifyMethods object value that specifies the notification methods used by the alert.
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 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.
Examples
Scheduling Automatic Administrative Tasks in SQL Server Agent
See Also
Reference
Microsoft.SqlServer.Management.Smo.Agent Namespace