• Article

Catalog 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 Catalog property specifies the default or initial catalog for the referenced OLE DB data source definition.

Syntax

object.Catalog [=value]

Parts

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

  • value
    A string that specifies a data source catalog

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetCatalog(SQLDMO_LPBSTR pRetVal);
HRESULT SetCatalog(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

The Catalog property provides a value for the OLE DB DBPROP_INIT_CATALOG initialization property when a connection is attempted to the data source that the LinkedServer object references. For more information about values for the Catalog property, see the OLE DB provider documentation.

Applies To:

LinkedServer Object