Skip to content

Commit 3fd4e97

Browse files
author
mtx48109
committed
class idbpropertiesimpl
1 parent c53a43a commit 3fd4e97

File tree

6 files changed

+95
-146
lines changed

6 files changed

+95
-146
lines changed

‎.openpublishing.redirection.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1775,6 +1775,21 @@
17751775
"redirect_url": "/cpp/data/oledb/idbinitializeimpl-class#uninitialize",
17761776
"redirect_document_id": false
17771777
},
1778+
{
1779+
"source_path": "docs/data/oledb/idbpropertiesimpl-getproperties.md",
1780+
"redirect_url": "/cpp/data/oledb/idbpropertiesimpl-class#getproperties",
1781+
"redirect_document_id": false
1782+
},
1783+
{
1784+
"source_path": "docs/data/oledb/idbpropertiesimpl-getpropertyinfo.md",
1785+
"redirect_url": "/cpp/data/oledb/idbpropertiesimpl-class#getpropertyinfo",
1786+
"redirect_document_id": false
1787+
},
1788+
{
1789+
"source_path": "docs/data/oledb/idbpropertiesimpl-setproperties.md",
1790+
"redirect_url": "/cpp/data/oledb/idbpropertiesimpl-class#setproperties",
1791+
"redirect_document_id": false
1792+
},
17781793
{
17791794
"source_path": "docs/dotnet/index.md",
17801795
"redirect_url": "/cpp/dotnet/dotnet-programming-with-cpp-cli-visual-cpp",

‎docs/data/oledb/TOC.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,6 @@
139139
### [IDBCreateSessionImpl Class](idbcreatesessionimpl-class.md)
140140
### [IDBInitializeImpl Class](idbinitializeimpl-class.md)
141141
### [IDBPropertiesImpl Class](idbpropertiesimpl-class.md)
142-
#### [IDBPropertiesImpl::GetProperties](idbpropertiesimpl-getproperties.md)
143-
#### [IDBPropertiesImpl::GetPropertyInfo](idbpropertiesimpl-getpropertyinfo.md)
144-
#### [IDBPropertiesImpl::SetProperties](idbpropertiesimpl-setproperties.md)
145142
### [IDBSchemaRowsetImpl Class](idbschemarowsetimpl-class.md)
146143
#### [IDBSchemaRowsetImpl::CheckRestrictions](idbschemarowsetimpl-checkrestrictions.md)
147144
#### [IDBSchemaRowsetImpl::CreateSchemaRowset](idbschemarowsetimpl-createschemarowset.md)

‎docs/data/oledb/idbpropertiesimpl-class.md‎

Lines changed: 80 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ ms.custom: ""
44
ms.date: "11/04/2016"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
7-
f1_keywords: ["IDBPropertiesImpl", "ATL.IDBPropertiesImpl", "ATL.IDBPropertiesImpl<T>", "ATL::IDBPropertiesImpl<T>", "ATL::IDBPropertiesImpl"]
7+
f1_keywords: ["IDBPropertiesImpl", "ATL.IDBPropertiesImpl", "ATL.IDBPropertiesImpl<T>", "ATL::IDBPropertiesImpl<T>", "ATL::IDBPropertiesImpl", "IDBPropertiesImpl::GetProperties", "IDBPropertiesImpl.GetProperties", "GetProperties", "IDBPropertiesImpl::GetPropertyInfo", "IDBPropertiesImpl.GetPropertyInfo", "GetPropertyInfo", "IDBPropertiesImpl.SetProperties", "SetProperties", "IDBPropertiesImpl::SetProperties"]
88
dev_langs: ["C++"]
9-
helpviewer_keywords: ["IDBPropertiesImpl class"]
9+
helpviewer_keywords: ["IDBPropertiesImpl class", "GetProperties method", "GetPropertyInfo method", "SetProperties method"]
1010
ms.assetid: a7f15a8b-95b2-4316-b944-d5d03f8d74ab
1111
author: "mikeblome"
1212
ms.author: "mblome"
@@ -23,26 +23,95 @@ class ATL_NO_VTABLE IDBPropertiesImpl
2323
: public IDBProperties, public CUtlProps<T>
2424
```
2525
26-
#### Parameters
27-
`T`
26+
### Parameters
27+
*T*
2828
Your class, derived from `IDBPropertiesImpl`.
29+
30+
## Requirements
31+
**Header:** atldb.h
2932
3033
## Members
3134
3235
### Interface Methods
3336
3437
|||
3538
|-|-|
36-
|[GetProperties](../../data/oledb/idbpropertiesimpl-getproperties.md)|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.|
37-
|[GetPropertyInfo](../../data/oledb/idbpropertiesimpl-getpropertyinfo.md)|Returns information about all properties supported by the provider.|
38-
|[SetProperties](../../data/oledb/idbpropertiesimpl-setproperties.md)|Sets properties in the Data Source and Initialization property groups, for data source objects, or the Initialization property group, for enumerators.|
39+
|[GetProperties](#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.|
40+
|[GetPropertyInfo](#getpropertyinfo)|Returns information about all properties supported by the provider.|
41+
|[SetProperties](#setproperties)|Sets properties in the Data Source and Initialization property groups, for data source objects, or the Initialization property group, for enumerators.|
3942
4043
## Remarks
41-
[IDBProperties](https://msdn.microsoft.com/en-us/library/ms719607.aspx) is a mandatory interface for data source objects and an optional interface for enumerators. However, if an enumerator exposes [IDBInitialize](https://msdn.microsoft.com/en-us/library/ms713706.aspx), it must expose `IDBProperties`. `IDBPropertiesImpl` implements `IDBProperties` by using a static function defined by [BEGIN_PROPSET_MAP](../../data/oledb/begin-propset-map.md).
44+
[IDBProperties](https://msdn.microsoft.com/library/ms719607.aspx) is a mandatory interface for data source objects and an optional interface for enumerators. However, if an enumerator exposes [IDBInitialize](https://msdn.microsoft.com/library/ms713706.aspx), it must expose `IDBProperties`. `IDBPropertiesImpl` implements `IDBProperties` by using a static function defined by [BEGIN_PROPSET_MAP](../../data/oledb/begin-propset-map.md).
45+
46+
## <a name="getproperties"></a> IDBPropertiesImpl::GetProperties
47+
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.
4248
43-
## Requirements
44-
**Header:** atldb.h
49+
### Syntax
50+
51+
```cpp
52+
STDMETHOD(GetProperties)(ULONG cPropertySets, 
53+
const DBPROPIDSET rgPropertySets[], 
54+
ULONG * pcProperties, 
55+
DBPROPSET ** prgProperties);
56+
```
57+
58+
#### Parameters
59+
See [IDBProperties::GetProperties](https://msdn.microsoft.com/library/ms714344.aspx) in the *OLE DB Programmer's Reference*.
60+
61+
Some parameters correspond to *OLE DB Programmer's Reference* parameters of different names, which are described in `IDBProperties::GetProperties`:
62+
63+
|OLE DB Template parameters|*OLE DB Programmer's Reference* parameters|
64+
|--------------------------------|------------------------------------------------|
65+
|*cPropertySets*|*cPropertyIDSets*|
66+
|*rgPropertySets*|*rgPropertyIDSets*|
67+
|*pcProperties*|*pcPropertySets*|
68+
|*prgProperties*|*prgPropertySets*|
69+
70+
### Remarks
71+
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.
72+
73+
## <a name="getpropertyinfo"></a> IDBPropertiesImpl::GetPropertyInfo
74+
Returns property information supported by the data source.
75+
76+
### Syntax
77+
78+
```cpp
79+
STDMETHOD(GetPropertyInfo)(ULONG cPropertySets, 
80+
const DBPROPIDSET rgPropertySets[], 
81+
ULONG * pcPropertyInfoSets, 
82+
DBPROPINFOSET ** prgPropertyInfoSets, 
83+
OLECHAR ** ppDescBuffer);
84+
```
85+
86+
#### Parameters
87+
See [IDBProperties::GetPropertyInfo](https://msdn.microsoft.com/library/ms718175.aspx) in the *OLE DB Programmer's Reference*.
88+
89+
Some parameters correspond to *OLE DB Programmer's Reference* parameters of different names, which are described in `IDBProperties::GetPropertyInfo`:
90+
91+
|OLE DB Template parameters|*OLE DB Programmer's Reference* parameters|
92+
|--------------------------------|------------------------------------------------|
93+
|*cPropertySets*|*cPropertyIDSets*|
94+
|*rgPropertySets*|*rgPropertyIDSets*|
95+
96+
### Remarks
97+
Uses [IDBInitializeImpl::m_pCUtlPropInfo](../../data/oledb/idbinitializeimpl-m-pcutlpropinfo.md) to implement this functionality.
98+
99+
## <a name="setproperties"></a> IDBPropertiesImpl::SetProperties
100+
Sets properties in the Data Source and Initialization property groups, for data source objects, or the Initialization property group, for enumerators.
101+
102+
### Syntax
103+
104+
```cpp
105+
STDMETHOD(SetProperties)(ULONG cPropertySets, 
106+
DBPROPSET rgPropertySets[]);
107+
```
108+
109+
#### Parameters
110+
See [IDBProperties::SetProperties](https://msdn.microsoft.com/library/ms723049.aspx) in the *OLE DB Programmer's Reference*.
111+
112+
### Remarks
113+
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.
45114

46115
## See Also
47116
[OLE DB Provider Templates](../../data/oledb/ole-db-provider-templates-cpp.md)
48-
[OLE DB Provider Template Architecture](../../data/oledb/ole-db-provider-template-architecture.md)
117+
[OLE DB Provider Template Architecture](../../data/oledb/ole-db-provider-template-architecture.md)

‎docs/data/oledb/idbpropertiesimpl-getproperties.md‎

Lines changed: 0 additions & 48 deletions
This file was deleted.

‎docs/data/oledb/idbpropertiesimpl-getpropertyinfo.md‎

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎docs/data/oledb/idbpropertiesimpl-setproperties.md‎

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)