| description | Learn more about: IDBPropertiesImpl Class | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| title | IDBPropertiesImpl Class | ||||||||||||
| ms.date | 11/04/2016 | ||||||||||||
| f1_keywords |
|
||||||||||||
| helpviewer_keywords |
|
||||||||||||
| ms.assetid | a7f15a8b-95b2-4316-b944-d5d03f8d74ab |
Provides an implementation for the IDBProperties interface.
template <class T>
class ATL_NO_VTABLE IDBPropertiesImpl
: public IDBProperties, public CUtlProps<T>T
Your class, derived from IDBPropertiesImpl.
Header: atldb.h
| Name | Description |
|---|---|
| GetProperties | Returns the values of properties in the Data Source, Data Source Information, and Initialization property groups that are currently set on the data source object or the values of properties in the Initialization property group that are currently set on the enumerator. |
| GetPropertyInfo | Returns information about all properties supported by the provider. |
| SetProperties | Sets properties in the Data Source and Initialization property groups, for data source objects, or the Initialization property group, for enumerators. |
IDBProperties is a mandatory interface for data source objects and an optional interface for enumerators. However, if an enumerator exposes IDBInitialize, it must expose IDBProperties. IDBPropertiesImpl implements IDBProperties by using a static function defined by BEGIN_PROPSET_MAP.
Returns the values of properties in the Data Source, Data Source Information, and Initialization property groups that are currently set on the data source object or the values of properties in the Initialization property group that are currently set on the enumerator.
STDMETHOD(GetProperties)(ULONG cPropertySets,
const DBPROPIDSET rgPropertySets[],
ULONG * pcProperties,
DBPROPSET ** prgProperties);See IDBProperties::GetProperties in the OLE DB Programmer's Reference.
Some parameters correspond to OLE DB Programmer's Reference parameters of different names, which are described in IDBProperties::GetProperties:
| OLE DB Template parameters | OLE DB Programmer's Reference parameters |
|---|---|
| cPropertySets | cPropertyIDSets |
| rgPropertySets | rgPropertyIDSets |
| pcProperties | pcPropertySets |
| prgProperties | prgPropertySets |
If the provider is initialized, this method returns the values of properties in the DBPROPSET_DATASOURCE, DBPROPSET_DATASOURCEINFO, DBPROPSET_DBINIT property groups that are currently set on the data source object. If the provider is not initialized, it returns DBPROPSET_DBINIT group properties only.
Returns property information supported by the data source.
STDMETHOD(GetPropertyInfo)(ULONG cPropertySets,
const DBPROPIDSET rgPropertySets[],
ULONG * pcPropertyInfoSets,
DBPROPINFOSET ** prgPropertyInfoSets,
OLECHAR ** ppDescBuffer);See IDBProperties::GetPropertyInfo in the OLE DB Programmer's Reference.
Some parameters correspond to OLE DB Programmer's Reference parameters of different names, which are described in IDBProperties::GetPropertyInfo:
| OLE DB Template parameters | OLE DB Programmer's Reference parameters |
|---|---|
| cPropertySets | cPropertyIDSets |
| rgPropertySets | rgPropertyIDSets |
Uses IDBInitializeImpl::m_pCUtlPropInfo to implement this functionality.
Sets properties in the Data Source and Initialization property groups, for data source objects, or the Initialization property group, for enumerators.
STDMETHOD(SetProperties)(ULONG cPropertySets,
DBPROPSET rgPropertySets[]);See IDBProperties::SetProperties in the OLE DB Programmer's Reference.
If the provider is initialized, this method sets the values of properties in the DBPROPSET_DATASOURCE, DBPROPSET_DATASOURCEINFO, DBPROPSET_DBINIT property groups for the data source object. If the provider is not initialized, it sets DBPROPSET_DBINIT group properties only.
OLE DB Provider Templates
OLE DB Provider Template Architecture