Share via


AlertSystem.PagerSubjectTemplate Property

Gets or sets the template text sent in the e-mail Subject: line in the e-mail sent by SQL Server Agent for pager notifications.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property PagerSubjectTemplate As String 
    Get 
    Set
'Usage
Dim instance As AlertSystem 
Dim value As String 

value = instance.PagerSubjectTemplate

instance.PagerSubjectTemplate = value
[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public string PagerSubjectTemplate { get; set; }
[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property String^ PagerSubjectTemplate {
    String^ get ();
    void set (String^ value);
}
[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member PagerSubjectTemplate : string with get, set
function get PagerSubjectTemplate () : String 
function set PagerSubjectTemplate (value : String)

Property Value

Type: System.String
A String value that specifies the e-mail Subject: text.

Remarks

For notifications sent due to a raised alert, the subject line is built as: "SQL Server Alert System: 'alert name' occurred on \\server", where alert name is the name of the alert and server is the network SQL Server name raising the alert.

For notifications sent due to job completion, the subject line is built as: "SQL Server Job System: 'job name' completed on \\server" where job name is the name of the job completing and server is the network SQL Server name on which the job was run.

In the template, SQL Server Agent replaces the character string <#S#> with the error message text of an alert.

Examples

Scheduling Automatic Administrative Tasks in SQL Server Agent

See Also

Reference

AlertSystem Class

Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Automated Administration Tasks (SQL Server Agent)

sp_add_alert (Transact-SQL)