Skip to content

Commit b23a645

Browse files
authored
Merge pull request #1107 from msebolt/consolidation-oledb
consolidation oledb caccessorbase
2 parents 527d4f7 + fe00049 commit b23a645

8 files changed

+114
-186
lines changed

.openpublishing.redirection.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -360,6 +360,31 @@
360360
"redirect_url": "/cpp/c-runtime-library/format-specification-syntax-printf-and-wprintf-functions#size",
361361
"redirect_document_id": false
362362
},
363+
{
364+
"source_path": "docs/data/oledb/caccessorbase-close.md",
365+
"redirect_url": "/cpp/data/oledb/caccessorbase-class#close",
366+
"redirect_document_id": false
367+
},
368+
{
369+
"source_path": "docs/data/oledb/caccessorbase-gethaccessor.md",
370+
"redirect_url": "/cpp/data/oledb/caccessorbase-class#geth",
371+
"redirect_document_id": false
372+
},
373+
{
374+
"source_path": "docs/data/oledb/caccessorbase-getnumaccessors.md",
375+
"redirect_url": "/cpp/data/oledb/caccessorbase-class#getnum",
376+
"redirect_document_id": false
377+
},
378+
{
379+
"source_path": "docs/data/oledb/caccessorbase-isautoaccessor.md",
380+
"redirect_url": "/cpp/data/oledb/caccessorbase-class#isauto",
381+
"redirect_document_id": false
382+
},
383+
{
384+
"source_path": "docs/data/oledb/caccessorbase-releaseaccessors.md",
385+
"redirect_url": "/cpp/data/oledb/caccessorbase-class#release",
386+
"redirect_document_id": false
387+
},
363388
{
364389
"source_path": "docs/dotnet/index.md",
365390
"redirect_url": "/cpp/dotnet/dotnet-programming-with-cpp-cli-visual-cpp",

docs/data/oledb/TOC.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,6 @@
9393
## [OLE DB Consumer Templates Reference](ole-db-consumer-templates-reference.md)
9494
### [CAccessor Class](caccessor-class.md)
9595
### [CAccessorBase Class](caccessorbase-class.md)
96-
#### [CAccessorBase::Close](caccessorbase-close.md)
97-
#### [CAccessorBase::GetHAccessor](caccessorbase-gethaccessor.md)
98-
#### [CAccessorBase::GetNumAccessors](caccessorbase-getnumaccessors.md)
99-
#### [CAccessorBase::IsAutoAccessor](caccessorbase-isautoaccessor.md)
100-
#### [CAccessorBase::ReleaseAccessors](caccessorbase-releaseaccessors.md)
10196
### [CAccessorRowset Class](caccessorrowset-class.md)
10297
#### [CAccessorRowset Members](caccessorrowset-members.md)
10398
#### [CAccessorRowset Methods](caccessorrowset-methods.md)

docs/data/oledb/caccessorbase-class.md

Lines changed: 89 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ ms.custom: ""
44
ms.date: "11/04/2016"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
7-
f1_keywords: ["CAccessorBase"]
7+
f1_keywords: ["CAccessorBase", "CAccessorBase.Close", "CAccessorBase::Close", "GetHAccessor", "CAccessorBase::GetHAccessor", "CAccessorBase.GetHAccessor",
8+
"CAccessorBase::GetNumAccessors", "GetNumAccessors", "CAccessorBase.GetNumAccessors", "IsAutoAccessor", "CAccessorBase.IsAutoAccessor", "CAccessorBase::IsAutoAccessor",
9+
"CAccessorBase::ReleaseAccessors", "CAccessorBase.ReleaseAccessors", "ReleaseAccessors"]
810
dev_langs: ["C++"]
9-
helpviewer_keywords: ["CAccessorBase class"]
11+
helpviewer_keywords: ["CAccessorBase class", "Close method", "GetHAccessor method", "GetNumAccessors method", "IsAutoAccessor method", "ReleaseAccessors method"]
1012
ms.assetid: 389b65be-11ca-4ae0-9290-60c621c4982b
1113
author: "mikeblome"
1214
ms.author: "mblome"
@@ -27,15 +29,93 @@ All accessors in the OLE DB Templates derive from this class. `CAccessorBase` al
2729

2830
|||
2931
|-|-|
30-
|[Close](../../data/oledb/caccessorbase-close.md)|Closes the accessors.|
31-
|[GetHAccessor](../../data/oledb/caccessorbase-gethaccessor.md)|Retrieves the accessor handle.|
32-
|[GetNumAccessors](../../data/oledb/caccessorbase-getnumaccessors.md)|Retrieves the number of accessors created by the class.|
33-
|[IsAutoAccessor](../../data/oledb/caccessorbase-isautoaccessor.md)|Tests whether the specified accessor is an autoaccessor.|
34-
|[ReleaseAccessors](../../data/oledb/caccessorbase-releaseaccessors.md)|Releases the accessors.|
35-
32+
|[Close](#close)|Closes the accessors.|
33+
|[GetHAccessor](#geth)|Retrieves the accessor handle.|
34+
|[GetNumAccessors](#getnum)|Retrieves the number of accessors created by the class.|
35+
|[IsAutoAccessor](#isauto)|Tests whether the specified accessor is an autoaccessor.|
36+
|[ReleaseAccessors](#release)|Releases the accessors.|
37+
3638
## Requirements
3739
**Header:** atldbcli.h
40+
41+
## <a name="close"></a> CAccessorBase::Close
42+
Closes the accessors.
43+
44+
### Syntax
45+
46+
```cpp
47+
void Close();
48+
49+
```
50+
51+
### Remarks
52+
You must call [ReleaseAccessors](../../data/oledb/caccessorbase-releaseaccessors.md) first.
53+
54+
## <a name="geth"></a> CAccessorBase::GetHAccessor
55+
Retrieves the accessor handle of a specified accessor.
56+
57+
### Syntax
58+
59+
```cpp
60+
HACCESSOR GetHAccessor(ULONG nAccessor) const;
61+
```
62+
63+
#### Parameters
64+
*nAccessor*
65+
[in] The zero-offset number for the accessor.
66+
67+
### Return Value
68+
The accessor handle.
69+
70+
## <a name="getnum"></a> CAccessorBase::GetNumAccessors
71+
Retrieves the number of accessors created by the class.
72+
73+
### Syntax
74+
75+
```cpp
76+
ULONG GetNumAccessors() const;
77+
78+
```
79+
80+
### Return Value
81+
The number of accessors created by the class.
82+
83+
## <a name="isauto"></a> CAccessorBase::IsAutoAccessor
84+
Returns true if data is automatically retrieved for the accessor during a Move operation.
85+
86+
### Syntax
87+
88+
```cpp
89+
bool IsAutoAccessor(ULONG nAccessor) const;
90+
```
91+
92+
#### Parameters
93+
*nAccessor*
94+
[in] The zero-offset number for the accessor.
95+
96+
### Return Value
97+
Returns **true** if the accessor is an autoaccessor. Otherwise, it returns **false**.
98+
99+
## <a name="release"></a> CAccessorBase::ReleaseAccessors
100+
Releases the accessors created by the class.
101+
102+
### Syntax
103+
104+
```cpp
105+
HRESULT ReleaseAccessors(IUnknown* pUnk);
106+
```
107+
108+
#### Parameters
109+
*pUnk*
110+
[in] A pointer to an `IUnknown` interface for the COM object for which the accessors have been created.
111+
112+
### Return Value
113+
A standard HRESULT.
114+
115+
### Remarks
116+
Called from [CAccessorRowset::Close](../../data/oledb/caccessorrowset-close.md).
38117

39118
## See Also
40119
[OLE DB Consumer Templates](../../data/oledb/ole-db-consumer-templates-cpp.md)
41-
[OLE DB Consumer Templates Reference](../../data/oledb/ole-db-consumer-templates-reference.md)
120+
[OLE DB Consumer Templates Reference](../../data/oledb/ole-db-consumer-templates-reference.md)
121+
[CAccessorBase Class](../../data/oledb/caccessorbase-class.md)

docs/data/oledb/caccessorbase-close.md

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

docs/data/oledb/caccessorbase-gethaccessor.md

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

docs/data/oledb/caccessorbase-getnumaccessors.md

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

docs/data/oledb/caccessorbase-isautoaccessor.md

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

docs/data/oledb/caccessorbase-releaseaccessors.md

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

0 commit comments

Comments
 (0)