EventDescriptionKeyword Property (SQL-DMO)

The EventDescriptionKeyword property restricts SQL Server Agent alert firing.

Applies To

Alert Object

Syntax

object.EventDescriptionKeyword [= value]

Part Description
object Expression that evaluates to an object in the Applies To list
value String to search for in the event message text

Remarks

A SQL Server Agent alert is raised in response to some condition occurring on a Microsoft® SQL Server™ installation. 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 the SQL Server installation in response to the condition. The EventDescriptionKeyword property represents this constraining text for a SQL Server Agent alert.

The SQL Server Agent performs a case-insensitive search of message text for the word specified by the EventDescriptionKeyword property.

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetEventDescriptionKeyword(SQLDMO_LPBSTR pRetVal);

HRESULT SetEventDescriptionKeyword(SQLDMO_LPCSTR NewValue);


Note 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 by using SysFreeString.


  


(c) 1988-98 Microsoft Corporation. All Rights Reserved.