EventDescriptionKeyword 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 EventDescriptionKeyword property restricts SQL Server Agent alert firing.

Syntax

object
.EventDescriptionKeyword [=value]

Parts

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

• value
  A string to search for in the event message text

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetEventDescriptionKeyword(SQLDMO_LPBSTR pRetVal);
HRESULT SetEventDescriptionKeyword(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

A SQL Server Agent alert is raised in response to some condition occurring on an instance of Microsoft SQL Server. An alert based on message number or severity can be constrained by indicating that a word or phrase must exist in the message text generated by an instance of SQL Server in response to the condition. The EventDescriptionKeyword property represents this constraining text for a SQL Server Agent alert.

SQL Server Agent performs a case-insensitive search of message text for the word the EventDescriptionKeywordproperty specifies.

Applies To:

Alert Object