Skip to content

Commit 3ade479

Browse files
author
mtx48109
committed
formatting review pr1
1 parent 0a673a1 commit 3ade479

30 files changed

+160
-318
lines changed

‎docs/data/oledb/accessing-xml-data.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,21 @@ There are two separate methods of retrieving XML data from a data source: one us
2525
## Retrieving XML Data Using CStreamRowset
2626
You specify [CStreamRowset](../../data/oledb/cstreamrowset-class.md) as the rowset type in your `CCommand` or `CTable` declaration. You can use it with your own accessor or no accessor, for example:
2727

28-
```
28+
```cpp
2929
CCommand<CAccessor<CMyAccessor>, CStreamRowset> myCmd;
3030
```
3131

3232
-or-
3333

34-
```
34+
```cpp
3535
CCommand<CNoAccessor, CStreamRowset> myCmd;
3636
```
3737

3838
Normally when you call `CCommand::Open` (specifying, for example, `CRowset` as the `TRowset` class), it obtains an `IRowset` pointer. `ICommand::Execute` returns an `IRowset` pointer, which is stored in the `m_spRowset` member of the `CRowset` object. Methods such as `MoveFirst`, `MoveNext`, and `GetData` use that pointer to retrieve the data.
3939

4040
By contrast, when you call `CCommand::Open` (but specify `CStreamRowset` as the `TRowset` class), `ICommand::Execute` returns an `ISequentialStream` pointer, which is stored in the `m_spStream` data member of [CStreamRowset](../../data/oledb/cstreamrowset-class.md). You then use the `Read` method to retrieve the (Unicode string) data in XML format. For example:
4141

42-
```
42+
```cpp
4343
myCmd.m_spStream->Read()
4444
```
4545

@@ -55,13 +55,13 @@ myCmd.m_spStream->Read()
5555

5656
Use `CXMLAccessor` as you would any other accessor class, passing it as a template parameter to `CCommand` or `CTable`:
5757

58-
```
58+
```cpp
5959
CTable<CXMLAccessor, CRowset> rs;
6060
```
6161

6262
Use [GetXMLRowData](../../data/oledb/cxmlaccessor-getxmlrowdata.md) to retrieve data from the table one row at a time, and navigate rows using methods such as `MoveNext`, for example:
6363

64-
```
64+
```cpp
6565
// Open data source, session, and rowset
6666
hr = rs.MoveFirst();
6767

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@ Represents one of the accessor types.
1717

1818
## Syntax
1919

20-
```
21-
20+
```cpp
2221
template <class T>
2322
class CAccessor : public CAccessorBase, public T
2423
```
2524
2625
#### Parameters
27-
`T`
26+
*T*
2827
The user record class.
2928
3029
## Remarks

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ ms.custom: ""
44
ms.date: "11/04/2016"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
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"]
7+
f1_keywords: ["CAccessorBase", "CAccessorBase.Close", "CAccessorBase::Close", "GetHAccessor", "CAccessorBase::GetHAccessor", "CAccessorBase.GetHAccessor", "CAccessorBase::GetNumAccessors", "GetNumAccessors", "CAccessorBase.GetNumAccessors", "IsAutoAccessor", "CAccessorBase.IsAutoAccessor", "CAccessorBase::IsAutoAccessor","CAccessorBase::ReleaseAccessors", "CAccessorBase.ReleaseAccessors", "ReleaseAccessors"]
108
dev_langs: ["C++"]
119
helpviewer_keywords: ["CAccessorBase class", "Close method", "GetHAccessor method", "GetNumAccessors method", "IsAutoAccessor method", "ReleaseAccessors method"]
1210
ms.assetid: 389b65be-11ca-4ae0-9290-60c621c4982b
@@ -45,7 +43,6 @@ Closes the accessors.
4543

4644
```cpp
4745
void Close();
48-
4946
```
5047

5148
### Remarks
@@ -57,7 +54,7 @@ Retrieves the accessor handle of a specified accessor.
5754
### Syntax
5855

5956
```cpp
60-
HACCESSOR GetHAccessor(ULONG nAccessor) const;
57+
HACCESSOR GetHAccessor(ULONG nAccessor) const;
6158
```
6259
6360
#### Parameters
@@ -74,7 +71,6 @@ Retrieves the number of accessors created by the class.
7471
7572
```cpp
7673
ULONG GetNumAccessors() const;
77-
7874
```
7975

8076
### Return Value
@@ -86,7 +82,7 @@ Returns true if data is automatically retrieved for the accessor during a Move o
8682
### Syntax
8783

8884
```cpp
89-
bool IsAutoAccessor(ULONG nAccessor) const;
85+
bool IsAutoAccessor(ULONG nAccessor) const;
9086
```
9187
9288
#### Parameters
@@ -118,4 +114,4 @@ HRESULT ReleaseAccessors(IUnknown* pUnk);
118114
## See Also
119115
[OLE DB Consumer Templates](../../data/oledb/ole-db-consumer-templates-cpp.md)
120116
[OLE DB Consumer Templates Reference](../../data/oledb/ole-db-consumer-templates-reference.md)
121-
[CAccessorBase Class](../../data/oledb/caccessorbase-class.md)
117+
[CAccessorBase Class](../../data/oledb/caccessorbase-class.md)

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

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,9 @@ ms.custom: ""
44
ms.date: "11/04/2016"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
7-
f1_keywords: ["CAccessorRowset", "ATL.CAccessorRowset", "ATL::CAccessorRowset", "CAccessorRowset.Bind", "CAccessorRowset::Bind",
8-
"CAccessorRowset::CAccessorRowset", "CAccessorRowset.CAccessorRowset", "CAccessorRowset", "ATL.CAccessorRowset.CAccessorRowset", "ATL::CAccessorRowset::CAccessorRowset",
9-
"CAccessorRowset.Close", "CAccessorRowset::Close", "CAccessorRowset::FreeRecordMemory", "CAccessorRowset.FreeRecordMemory", "FreeRecordMemory",
10-
"GetColumnInfo", "CAccessorRowset.GetColumnInfo", "CAccessorRowset::GetColumnInfo"]
7+
f1_keywords: ["CAccessorRowset", "ATL.CAccessorRowset", "ATL::CAccessorRowset", "CAccessorRowset.Bind", "CAccessorRowset::Bind", "CAccessorRowset::CAccessorRowset", "CAccessorRowset.CAccessorRowset", "CAccessorRowset", "ATL.CAccessorRowset.CAccessorRowset", "ATL::CAccessorRowset::CAccessorRowset", "CAccessorRowset.Close", "CAccessorRowset::Close", "CAccessorRowset::FreeRecordMemory", "CAccessorRowset.FreeRecordMemory", "FreeRecordMemory", "GetColumnInfo", "CAccessorRowset.GetColumnInfo", "CAccessorRowset::GetColumnInfo"]
118
dev_langs: ["C++"]
12-
helpviewer_keywords: ["CAccessorRowset class", "CAccessorRowset class, methods", "CAccessorRowset class, members", "Bind method", "CAccessorRowset class, constructor",
13-
"Close method", "FreeRecordMemory method", "GetColumnInfo method"]
9+
helpviewer_keywords: ["CAccessorRowset class", "CAccessorRowset class, methods", "CAccessorRowset class, members", "Bind method", "CAccessorRowset class, constructor", "Close method", "FreeRecordMemory method", "GetColumnInfo method"]
1410
ms.assetid: bd4f58ed-cebf-4d43-8985-1e5fcbf06953
1511
author: "mikeblome"
1612
ms.author: "mblome"
@@ -23,7 +19,7 @@ Encapsulates a rowset and its associated accessors in a single class.
2319

2420
```cpp
2521
template <class TAccessor = CNoAccessor,
26-
template <typename T> class TRowset = CRowset>
22+
template <typename T> class TRowset = CRowset>
2723
class CAccessorRowset : public TAccessor, public TRowset<TAccessor>
2824
```
2925
@@ -59,7 +55,6 @@ Creates the bindings if you specified `bBind` as **false** in [CCommand::Open](.
5955
6056
```cpp
6157
HRESULT Bind();
62-
6358
```
6459

6560
### Return Value
@@ -72,7 +67,6 @@ Initializes the `CAccessorRowset` object.
7267

7368
```cpp
7469
CAccessorRowset();
75-
7670
```
7771

7872
## <a name="close"></a> CAccessorRowset::Close
@@ -82,7 +76,6 @@ Releases any active accessors and the rowset.
8276

8377
```cpp
8478
void Close();
85-
8679
```
8780

8881
### Remarks
@@ -95,7 +88,6 @@ Frees any columns in the current record that need to be freed.
9588

9689
```cpp
9790
void FreeRecordMemory();
98-
9991
```
10092

10193
## <a name="getcolumninfo"></a> CAccessorRowset::GetColumnInfo
@@ -104,24 +96,24 @@ Gets column information from the opened rowset.
10496
### Syntax
10597

10698
```cpp
107-
HRESULT GetColumnInfo(DBORDINAL* pulColumns,
108-
DBCOLUMNINFO** ppColumnInfo,
109-
LPOLESTR* ppStrings) const;
110-
111-
HRESULT GetColumnInfo(DBORDINAL* pColumns,
99+
HRESULT GetColumnInfo(DBORDINAL* pulColumns,
100+
DBCOLUMNINFO** ppColumnInfo,
101+
LPOLESTR* ppStrings) const;
102+
103+
HRESULT GetColumnInfo(DBORDINAL* pColumns,
112104
DBCOLUMNINFO** ppColumnInfo);
113105
```
114106
115107
#### Parameters
116-
See [IColumnsInfo::GetColumnInfo](https://msdn.microsoft.com/en-us/library/ms722704.aspx) in the *OLE DB Programmer's Reference*.
108+
See [IColumnsInfo::GetColumnInfo](https://msdn.microsoft.com/library/ms722704.aspx) in the *OLE DB Programmer's Reference*.
117109
118110
### Return Value
119111
A standard HRESULT.
120112
121113
### Remarks
122114
The user must free the returned column information and string buffer. Use the second version of this method when you use [CDynamicAccessor](../../data/oledb/cdynamicaccessor-class.md) and need to override the bindings.
123115
124-
For more information, see [IColumnsInfo::GetColumnInfo](https://msdn.microsoft.com/en-us/library/ms722704.aspx) in the *OLE DB Programmer's Reference*.
116+
For more information, see [IColumnsInfo::GetColumnInfo](https://msdn.microsoft.com/library/ms722704.aspx) in the *OLE DB Programmer's Reference*.
125117
126118
## See Also
127119
[OLE DB Consumer Templates](../../data/oledb/ole-db-consumer-templates-cpp.md)

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

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@ ms.custom: ""
44
ms.date: "11/04/2016"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
7-
f1_keywords: ["ATL.CArrayRowset<TAccessor>", "ATL.CArrayRowset", "CArrayRowset", "ATL::CArrayRowset", "ATL::CArrayRowset<TAccessor>",
8-
"ATL::CArrayRowset::CArrayRowset", "CArrayRowset.CArrayRowset", "ATL.CArrayRowset.CArrayRowset", "ATL.CArrayRowset<TAccessor>.CArrayRowset", "CArrayRowset::CArrayRowset", "CArrayRowset", "CArrayRowset<TAccessor>::CArrayRowset", "ATL::CArrayRowset<TAccessor>::CArrayRowset",
9-
"CArrayRowset<TAccessor>.Snapshot", "ATL::CArrayRowset::Snapshot", "Snapshot", "CArrayRowset<TAccessor>::Snapshot", "ATL.CArrayRowset.Snapshot", "ATL.CArrayRowset<TAccessor>.Snapshot", "ATL::CArrayRowset<TAccessor>::Snapshot", "CArrayRowset::Snapshot", "CArrayRowset.Snapshot",
10-
"CArrayRowset::operator[]", "CArrayRowset.operator[]",
11-
"ATL::CArrayRowset::m_nRowsRead", "ATL::CArrayRowset<TAccessor>::m_nRowsRead", "CArrayRowset<TAccessor>::m_nRowsRead", "ATL.CArrayRowset<TAccessor>.m_nRowsRead", "CArrayRowset.m_nRowsRead", "m_nRowsRead", "ATL.CArrayRowset.m_nRowsRead", "CArrayRowset::m_nRowsRead"]
7+
f1_keywords: ["ATL.CArrayRowset<TAccessor>", "ATL.CArrayRowset", "CArrayRowset", "ATL::CArrayRowset", "ATL::CArrayRowset<TAccessor>", "ATL::CArrayRowset::CArrayRowset", "CArrayRowset.CArrayRowset", "ATL.CArrayRowset.CArrayRowset", "ATL.CArrayRowset<TAccessor>.CArrayRowset", "CArrayRowset::CArrayRowset", "CArrayRowset", "CArrayRowset<TAccessor>::CArrayRowset", "ATL::CArrayRowset<TAccessor>::CArrayRowset", "CArrayRowset<TAccessor>.Snapshot", "ATL::CArrayRowset::Snapshot", "Snapshot", "CArrayRowset<TAccessor>::Snapshot", "ATL.CArrayRowset.Snapshot", "ATL.CArrayRowset<TAccessor>.Snapshot", "ATL::CArrayRowset<TAccessor>::Snapshot", "CArrayRowset::Snapshot", "CArrayRowset.Snapshot", "CArrayRowset::operator[]", "CArrayRowset.operator[]", "ATL::CArrayRowset::m_nRowsRead", "ATL::CArrayRowset<TAccessor>::m_nRowsRead", "CArrayRowset<TAccessor>::m_nRowsRead", "ATL.CArrayRowset<TAccessor>.m_nRowsRead", "CArrayRowset.m_nRowsRead", "m_nRowsRead", "ATL.CArrayRowset.m_nRowsRead", "CArrayRowset::m_nRowsRead"]
128
dev_langs: ["C++"]
139
helpviewer_keywords: ["CArrayRowset class", "CArrayRowset class, constructor", "Snapshot method", "operator [], arrays", "[] operator", "operator[], arrays", "m_nRowsRead"]
1410
ms.assetid: 511427e1-73ca-4fd8-9ba1-ae9463557cb6
@@ -23,8 +19,8 @@ Accesses elements of a rowset using array syntax.
2319

2420
```cpp
2521
template < class TAccessor >
26-
class CArrayRowset :
27-
public CVirtualBuffer <TAccessor>, 
22+
class CArrayRowset :
23+
public CVirtualBuffer <TAccessor>, 
2824
protected CBulkRowset <TAccessor>
2925
```
3026
@@ -62,7 +58,7 @@ Creates a new `CArrayRowset` object.
6258
### Syntax
6359
6460
```cpp
65-
CArrayRowset(int nMax = 100000);
61+
CArrayRowset(int nMax = 100000);
6662
```
6763

6864
#### Parameters
@@ -76,7 +72,6 @@ Reads the entire rowset into memory, creating an image or snapshot of it.
7672

7773
```cpp
7874
HRESULT Snapshot() throw();
79-
8075
```
8176

8277
## <a name="operator"></a> CArrayRowset::operator
@@ -85,8 +80,7 @@ Provides array-like syntax for accessing a row in the rowset.
8580
### Syntax
8681

8782
```cpp
88-
TAccessor
89-
& operator[](int nrow);
83+
TAccessor & operator[](int nrow);
9084
```
9185

9286
#### Parameters
@@ -109,7 +103,6 @@ Contains the number of rows in the rowset that have already been read.
109103

110104
```cpp
111105
ULONG m_nRowsRead;
112-
113106
```
114107

115108
## See Also

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

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,9 @@ ms.custom: ""
44
ms.date: "11/04/2016"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
7-
f1_keywords: ["ATL.CBookmark", "ATL::CBookmark<nSize>", "CBookmark", "ATL.CBookmark<nSize>", "ATL::CBookmark",
8-
"CBookmark<0>.CBookmark<0>", "CBookmark::CBookmark", "ATL.CBookmark.CBookmark", "CBookmark.CBookmark", "CBookmark", "ATL::CBookmark<0>::CBookmark<0>", "ATL.CBookmark<0>.CBookmark<0>", "CBookmark<0>::CBookmark<0>", "ATL::CBookmark::CBookmark",
9-
"ATL.CBookmark<0>.GetBuffer", "ATL.CBookmark.GetBuffer", "ATL::CBookmark<0>::GetBuffer", "ATL::CBookmark::GetBuffer", "CBookmark.GetBuffer", "ATL::CBookmark<nSize>::GetBuffer", "ATL.CBookmark<nSize>.GetBuffer", "CBookmark<0>.GetBuffer", "CBookmark<nSize>::GetBuffer", "CBookmark<0>::GetBuffer", "CBookmark<nSize>.GetBuffer", "CBookmark::GetBuffer",
10-
"CBookmark::GetSize", "ATL.CBookmark<nSize>.GetSize", "CBookmark<nSize>.GetSize", "CBookmark.GetSize", "ATL::CBookmark::GetSize", "CBookmark<0>::GetSize", "ATL::CBookmark<nSize>::GetSize", "ATL.CBookmark<0>.GetSize", "ATL::CBookmark<0>::GetSize", "ATL.CBookmark.GetSize", "CBookmark<0>.GetSize", "CBookmark<nSize>::GetSize",
11-
"CBookmark<0>::SetBookmark", "ATL.CBookmark<0>.SetBookmark", "CBookmark<0>.SetBookmark", "SetBookmark", "ATL::CBookmark::SetBookmark", "ATL::CBookmark<0>::SetBookmark", "CBookmark.SetBookmark", "ATL.CBookmark.SetBookmark", "CBookmark::SetBookmark",
12-
"CBookmark<0>::operator=", "CBookmark<0>.operator=", "ATL.CBookmark.operator=", "CBookmark::operator=", "ATL.CBookmark<0>.operator=", "ATL::CBookmark<0>::operator=", "CBookmark.operator=", "ATL::CBookmark::operator="]
7+
f1_keywords: ["ATL.CBookmark", "ATL::CBookmark<nSize>", "CBookmark", "ATL.CBookmark<nSize>", "ATL::CBookmark", "CBookmark<0>.CBookmark<0>", "CBookmark::CBookmark", "ATL.CBookmark.CBookmark", "CBookmark.CBookmark", "CBookmark", "ATL::CBookmark<0>::CBookmark<0>", "ATL.CBookmark<0>.CBookmark<0>", "CBookmark<0>::CBookmark<0>", "ATL::CBookmark::CBookmark", "ATL.CBookmark<0>.GetBuffer", "ATL.CBookmark.GetBuffer", "ATL::CBookmark<0>::GetBuffer", "ATL::CBookmark::GetBuffer", "CBookmark.GetBuffer", "ATL::CBookmark<nSize>::GetBuffer", "ATL.CBookmark<nSize>.GetBuffer", "CBookmark<0>.GetBuffer", "CBookmark<nSize>::GetBuffer", "CBookmark<0>::GetBuffer", "CBookmark<nSize>.GetBuffer", "CBookmark::GetBuffer", "CBookmark::GetSize", "ATL.CBookmark<nSize>.GetSize", "CBookmark<nSize>.GetSize", "CBookmark.GetSize", "ATL::CBookmark::GetSize", "CBookmark<0>::GetSize", "ATL::CBookmark<nSize>::GetSize", "ATL.CBookmark<0>.GetSize", "ATL::CBookmark<0>::GetSize", "ATL.CBookmark.GetSize", "CBookmark<0>.GetSize", "CBookmark<nSize>::GetSize", "CBookmark<0>::SetBookmark", "ATL.CBookmark<0>.SetBookmark", "CBookmark<0>.SetBookmark", "SetBookmark", "ATL::CBookmark::SetBookmark", "ATL::CBookmark<0>::SetBookmark", "CBookmark.SetBookmark", "ATL.CBookmark.SetBookmark", "CBookmark::SetBookmark", "CBookmark<0>::operator=", "CBookmark<0>.operator=", "ATL.CBookmark.operator=", "CBookmark::operator=", "ATL.CBookmark<0>.operator=", "ATL::CBookmark<0>::operator=", "CBookmark.operator=", "ATL::CBookmark::operator="]
138
dev_langs: ["C++"]
14-
helpviewer_keywords: ["CBookmark class", "CBookmark class, constructor", "GetBuffer method", "GetSize method", "SetBookmark method",
15-
"= operator, with OLE DB templates", "operator =, bookmarks", "operator=, bookmarks"]
9+
helpviewer_keywords: ["CBookmark class", "CBookmark class, constructor", "GetBuffer method", "GetSize method", "SetBookmark method", "= operator, with OLE DB templates", "operator =, bookmarks", "operator=, bookmarks"]
1610
ms.assetid: bc942f95-6f93-41d9-bb6e-bcdae4ae0b7a
1711
author: "mikeblome"
1812
ms.author: "mblome"
@@ -64,8 +58,8 @@ The constructor.
6458
### Syntax
6559
6660
```cpp
67-
CBookmark(); 
68-
61+
CBookmark();
62+
 
6963
CBookmark(DBLENGTH nSize);
7064
```
7165

@@ -86,7 +80,6 @@ Retrieves the pointer to the bookmark buffer.
8680

8781
```cpp
8882
virtual BYTE* GetBuffer() const throw();
89-
9083
```
9184

9285
### Return Value
@@ -99,7 +92,6 @@ Retrieves the size of the bookmark buffer.
9992

10093
```cpp
10194
virtual DBLENGTH GetSize() const throw();
102-
10395
```
10496

10597
### Return Value
@@ -110,9 +102,8 @@ Copies the bookmark value referenced by *pBuffer* to the `CBookmark` buffer and
110102

111103
### Syntax
112104

113-
```
114-
HRESULT SetBookmark(DBLENGTH nSize,
115-
BYTE* pBuffer) throw();
105+
```cpp
106+
HRESULT SetBookmark(DBLENGTH nSize, BYTE* pBuffer) throw();
116107
```
117108
118109
#### Parameters
@@ -134,7 +125,7 @@ Assigns a `CBookmark` object to another.
134125
### Syntax
135126
136127
```cpp
137-
CBookmark& operator =(const CBookmark& bookmark) throw();
128+
CBookmark& operator =(const CBookmark& bookmark) throw();
138129
```
139130

140131
### Remarks

0 commit comments

Comments
 (0)