The DatabaseName property represents the name of an existing Microsoft® SQL Server™ database. It constrains SQL Server Agent alerts or directs execution of SQL Server Agent job steps.
Alert Object | JobStep Object |
object.DatabaseName [= value]
Part | Description |
---|---|
object | Expression that evaluates to an object in the Applies To list |
value | Specifies an existing SQL Server database by name |
SQL Server Agent alerts can be fired when a specified system message is generated by an action occurring on a SQL Server installation. 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 when a database is full and can accept no more rows. An Alert object representing this alert for the Northwind database would have a MessageID value of 1105 and a DatabaseName 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.
String
Read/write. When setting the property for an Alert or JobStep, the value must reference an existing SQL Server database.
HRESULT GetDatabaseName(SQLDMO_LPBSTR pRetVal);
HRESULT SetDatabaseName(SQLDMO_LPCSTR NewVal);
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.