ProviderString 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 ProviderString property specifies OLE DB provider-specific connection data required to implement a connection to the referenced OLE DB data source.

Syntax

object
.ProviderString [= value]

Parts

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

  • value
    A string with a maximum of 4,000 characters

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetProviderString(SQLDMO_LPBSTR pRetVal);
HRESULT SetProviderString(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 ProviderString property is provided as the value of the OLE DB initialization property DBPROP_INIT_PROVIDERSTRING when a connection is established to the OLE DB data source identified by the LinkedServer object. For more information about requirements for, and structure of, an appropriate property value, see the OLE DB provider documentation.

Applies To: