• Article

DatabaseName 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 DatabaseName property represents the name of an existing Microsoft SQL Server database. It constrains SQL Server Agent service alerts or directs execution of SQL Server Agent job steps.

Syntax

object.DatabaseName [= value]

Parts

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

  • value
    Specifies an existing SQL Server database by name

Data Type

String

Modifiable

Read/write. When the property is set for an Alert or JobStep object, the value must reference an existing SQL Server database.

Prototype (C/C++)

HRESULT GetDatabaseName(SQLDMO_LPBSTR pRetVal);
HRESULT SetDatabaseName(SQLDMO_LPCSTR NewVal);

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

SQL Server Agent alerts can be fired when a specified system message is generated by an action occurring on an instance of SQL Server. Alerts based on messages can be constrained so the alert is only fired when the action occurs within a single database. For example, system message 1105 is generated if a database is full and can accept no more rows. An Alert object representing this alert for the Northwind database has a MessageID property value of 1105 and a DatabaseName property value of Northwind.

Each step of a SQL Server Agent job can execute in a specified database. Setting the DatabaseName property of a JobStep object directs the execution of the represented step.