PagerSubjectTemplate 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 PagerSubjectTemplate property specifies text used to build the subject line of an e-mail message implementing pager notification for all Microsoft SQL Server operators.

Syntax

object
.PagerSubjectTemplate [= value]

Parts

• object
  An expression that evaluates to an object in the Applies To list

• value
  A string

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetPagerSubjectTemplate(SQLDMO_LPBSTR pRetVal);
HRESULT SetPagerSubjectTemplate(SQLDMO_LPCSTR NewValue);

Note

SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

If not assigned, SQL Server Agent builds an e-mail message, using the alert subject text to fill the subject line.

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.

Applies To:

AlertSystem Object