Alert.IncludeEventDescription Property

Article
12/03/2008

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
Public Property IncludeEventDescription As NotifyMethods

public NotifyMethods IncludeEventDescription { get; set; }

public:
property NotifyMethods IncludeEventDescription {
    NotifyMethods get ();
    void set (NotifyMethods value);
}

/** @property */
public NotifyMethods get_IncludeEventDescription ()

/** @property */
public void set_IncludeEventDescription (NotifyMethods value)

public function get IncludeEventDescription () : NotifyMethods

public function set IncludeEventDescription (value : NotifyMethods)

Property Value

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.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.

Example

How to: Create an Alert in Visual Basic .NET

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms