Skip to content

Commit 3a7948a

Browse files
author
msebolt
committed
code updates
1 parent fa46f26 commit 3a7948a

12 files changed

+112
-120
lines changed

‎docs/data/oledb/consumer-wizard-generated-methods.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ int main(int argc, char* argv[])
6868
}
6969
```
7070
71-
## Remarks
71+
### Remarks
7272
7373
If you define a `HasBookmark` method, the `OpenAll` code sets the `DBPROP_IRowsetLocate` property; make sure you only do this if your provider supports that property.
7474
@@ -133,7 +133,7 @@ void GetRowsetProperties(CDBPropSet* pPropSet)
133133
}
134134
```
135135

136-
## Remarks
136+
### Remarks
137137

138138
You shouldn't define a global `GetRowsetProperties` method because it could conflict with the one defined by the wizard. This is a wizard-generated method that you get with templated and attributed projects; the attributes don't inject this code.
139139

@@ -145,7 +145,7 @@ HRESULT OpenDataSource(); 
145145
void CloseDataSource();
146146
```
147147

148-
## Remarks
148+
### Remarks
149149

150150
The wizard defines the methods `OpenDataSource` and `CloseDataSource`; `OpenDataSource` calls [CDataSource::OpenFromInitializationString](../../data/oledb/cdatasource-openfrominitializationstring.md).
151151

‎docs/data/oledb/defining-stored-procedures.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Defining Stored Procedures | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "11/04/2016"
4+
ms.date: "10/24/2018"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
77
dev_langs: ["C++"]
@@ -16,7 +16,7 @@ ms.workload: ["cplusplus", "data-storage"]
1616
Before calling a stored procedure, you must first define it, using the [DEFINE_COMMAND](../../data/oledb/define-command.md) macro. When you define the command, denote parameters with a question mark (?) as the parameter marker:
1717

1818
```cpp
19-
DEFINE_COMMAND(CMySProcAccessor, _T("{INSERT {name, phone} into shippers (?,?)}")
19+
DEFINE_COMMAND_EX(CMySProcAccessor, _T("{INSERT {name, phone} INTO shippers (?,?)}"))
2020
```
2121
2222
The syntax (the use of braces, and so on) used in the code examples in this topic is specific to SQL Server. The syntax that you use in your stored procedures might vary according to the provider you use.
@@ -35,8 +35,8 @@ END_PARAM_MAP()
3535
The previous example defines a stored procedure as it goes. Typically, for efficient reuse of code, a database contains a set of predefined stored procedures with names such as `Sales by Year` or `dt_adduserobject`. You can view their definitions using SQL Server Enterprise Manager. You call them as follows (the placement of the *?* parameters depend on the stored procedure's interface):
3636

3737
```cpp
38-
DEFINE_COMMAND(CMySProcAccessor, _T("{CALL \"Sales by Year\" (?,?) }")
39-
DEFINE_COMMAND(CMySProcAccessor, _T("{CALL dbo.dt_adduserobject (?,?) }")
38+
DEFINE_COMMAND_EX(CMySProcAccessor, _T("{CALL \"Sales by Year\" (?,?) }"))
39+
DEFINE_COMMAND_EX(CMySProcAccessor, _T("{CALL dbo.dt_adduserobject (?,?) }"))
4040
```
4141
4242
Next, declare the command class:

‎docs/data/oledb/field-status-data-members-in-wizard-generated-accessors.md‎

Lines changed: 59 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Field Status Data Members in Wizard-Generated Accessors | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "11/04/2016"
4+
ms.date: "10/24/2018"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
77
dev_langs: ["C++"]
@@ -19,52 +19,35 @@ For example, for a data member *m_OwnerID*, the wizard generates an additional d
1919

2020
This is shown in the following code:
2121

22-
```cpp
23-
[db_source("insert connection string")]
24-
[db_command(" \
25-
SELECT \
26-
Au_ID, \
27-
Author, \
28-
`Year Born`, \
29-
FROM Authors")]
30-
31-
class CAuthors
22+
```cpp
23+
class CAuthorsAccessor
3224
{
3325
public:
26+
LONG m_AuID;
27+
TCHAR m_Author[53];
28+
LONG m_YearBorn;
29+
30+
DBSTATUS m_dwAuIDStatus;
31+
DBSTATUS m_dwAuthorStatus;
32+
DBSTATUS m_dwYearBornStatus;
3433

35-
// The following wizard-generated data members contain status
36-
// values for the corresponding fields in the column map. You
37-
// can use these values to hold NULL values that the database
38-
// returns or to hold error information when the compiler returns
39-
// errors. See "Field Status Data Members in Wizard-Generated
40-
// Accessors" in the Visual C++ documentation for more information
41-
// on using these fields.
42-
DWORD m_dwAuIDStatus;
43-
DWORD m_dwAuthorStatus;
44-
DWORD m_dwYearBornStatus;
45-
46-
// The following wizard-generated data members contain length
47-
// values for the corresponding fields in the column map.
48-
DWORD m_dwAuIDLength;
49-
DWORD m_dwAuthorLength;
50-
DWORD m_dwYearBornLength;
51-
52-
BEGIN_COLUMN_MAP(CAuthorsAccessor)
53-
COLUMN_ENTRY_LENGTH_STATUS(1, m_AuID, dwAuIDLength, dwAuIDStatus)
54-
COLUMN_ENTRY_LENGTH_STATUS(2, m_Author, dwAuthorLength, dwAuthorStatus)
55-
COLUMN_ENTRY_LENGTH_STATUS(3, m_YearBorn, dwYearBornLength, dwYearBornStatus)
56-
END_COLUMN_MAP()
57-
58-
[ db_column(1, status=m_dwAuIDStatus, length=m_dwAuIDLength) ] LONG m_AuID;
59-
[ db_column(2, status=m_dwAuthorStatus, length=m_dwAuthorLength) ] TCHAR m_Author[51];
60-
[ db_column(3, status=m_dwYearBornStatus, length=m_dwYearBornLength) ] SHORT m_YearBorn;
61-
62-
void GetRowsetProperties(CDBPropSet* pPropSet)
63-
{
64-
pPropSet->AddProperty(DBPROP_IRowsetChange, true);
65-
pPropSet->AddProperty(DBPROP_UPDATABILITY, DBPROPVAL_UP_CHANGE | DBPROPVAL_UP_INSERT | DBPROPVAL_UP_DELETE);
66-
}
67-
};
34+
DBLENGTH m_dwAuIDLength;
35+
DBLENGTH m_dwAuthorLength;
36+
DBLENGTH m_dwYearBornLength;
37+
38+
DEFINE_COMMAND_EX(CAuthorsAccessor, L" \
39+
SELECT \
40+
AuID, \
41+
Author, \
42+
YearBorn \
43+
FROM dbo.Authors")
44+
45+
BEGIN_COLUMN_MAP(CAuthorsAccessor)
46+
COLUMN_ENTRY_LENGTH_STATUS(1, m_AuID, dwAuIDLength, dwAuIDStatus)
47+
COLUMN_ENTRY_LENGTH_STATUS(2, m_Author, dwAuthorLength, dwAuthorStatus)
48+
COLUMN_ENTRY_LENGTH_STATUS(3, m_YearBorn, dwYearBornLength, dwYearBornStatus)
49+
END_COLUMN_MAP()
50+
...
6851
```
6952
7053
> [!NOTE]
@@ -84,34 +67,39 @@ You can retrieve the length of a variable-length column or the status of a colum
8467
8568
- To get the status, use the COLUMN_ENTRY_STATUS macro.
8669
87-
- To get both, use COLUMN_ENTRY_LENGTH_STATUS, as shown below.
88-
89-
```cpp
90-
class CProducts
91-
{
92-
public:
93-
char szName[40];
94-
long nNameLength;
95-
DBSTATUS nNameStatus;
96-
97-
BEGIN_COLUMN_MAP(CProducts)
98-
// Bind the column to CProducts.m_ProductName.
99-
// nOrdinal is zero-based, so the column number of m_ProductName is 1.
100-
COLUMN_ENTRY_LENGTH_STATUS(1, szName, nNameLength, nNameStatus)
101-
END_COLUMN_MAP()
102-
};
103-
104-
CTable<CAccessor<CProducts >> product;
105-
106-
product.Open(session, "Product");
70+
- To get both, use COLUMN_ENTRY_LENGTH_STATUS, as shown:
71+
72+
```cpp
73+
class CProducts
74+
{
75+
public:
76+
char szName[40];
77+
long nNameLength;
78+
DBSTATUS nNameStatus;
79+
80+
BEGIN_COLUMN_MAP(CProducts)
81+
// Bind the column to CProducts.m_ProductName.
82+
// nOrdinal is zero-based, so the column number of m_ProductName is 1.
83+
COLUMN_ENTRY_LENGTH_STATUS(1, szName, nNameLength, nNameStatus)
84+
END_COLUMN_MAP()
85+
};
86+
```
10787
108-
while (product.MoveNext() == S_OK)
109-
{
110-
// Check the product name isn't NULL before tracing it
111-
if (product.nNameStatus == DBSTATUS_S_OK)
112-
ATLTRACE("%s is %d characters\n", szName, nNameLength);
113-
}
114-
```
88+
- Then, access the length and/or status as shown:
89+
90+
```cpp
91+
CTable<CAccessor<CProducts >> product;
92+
CSession session;
93+
94+
product.Open(session, "Product");
95+
96+
while (product.MoveNext() == S_OK)
97+
{
98+
// Check the product name isn't NULL before tracing it
99+
if (product.nNameStatus == DBSTATUS_S_OK)
100+
ATLTRACE("%s is %d characters\n", product.szName, product.nNameLength);
101+
}
102+
```
115103
116104
When you use `CDynamicAccessor`, the length and status are bound for you automatically. To retrieve the length and status values, use the `GetLength` and `GetStatus` member functions.
117105

‎docs/data/oledb/obtaining-metadata-with-schema-rowsets.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Obtaining Metadata with Schema Rowsets | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "11/04/2016"
4+
ms.date: "10/24/2018"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
77
dev_langs: ["C++"]
@@ -37,7 +37,7 @@ ANSI SQL defines a catalog/schema model for data stores; OLE DB uses this model.
3737
When you query for schema information, you can use restrictions to specify the type of information in which you're interested. You can think of restrictions as a filter or qualifier in a query. For example, in the query:
3838

3939
```sql
40-
SELECT * FROM authors where l_name = 'pivo'
40+
SELECT * FROM authors WHERE l_name = 'pivo'
4141
```
4242

4343
`l_name` is a restriction. This is a simple example with only one restriction; the schema rowset classes support several restrictions.
@@ -64,15 +64,15 @@ So, for example, if you want to restrict by table name, TABLE_NAME is the third
6464
CDataSource ds;
6565
ds.Open();
6666
CSession ss;
67-
ss.Open();
68-
CColumns ColumnSchemaRowset;
67+
ss.Open(ds);
68+
CColumns columnSchemaRowset;
6969
// TABLE_NAME is the third restriction column, so
7070
// specify "authors" as the third restriction parameter:
71-
hr = ColumnSchemaRowset.Open(ss, NULL, NULL, "authors");
72-
hr = ColumnSchemaRowset.MoveFirst();
71+
HRESULT hr = columnSchemaRowset.Open(ss, NULL, NULL, L"authors");
72+
hr = columnSchemaRowset.MoveFirst();
7373
while (hr == S_OK)
7474
{
75-
hr = ColumnSchemaRowset.MoveNext();
75+
hr = columnSchemaRowset.MoveNext();
7676
}
7777
```
7878

‎docs/data/oledb/output-parameters.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Output Parameters | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "11/04/2016"
4+
ms.date: "10/24/2018"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
77
dev_langs: ["C++"]
@@ -18,7 +18,7 @@ Calling a stored procedure is similar to running a SQL command. The main differe
1818
In the following stored procedure, the first '?' is the return value (phone) and the second '?' is the input parameter (name):
1919

2020
```cpp
21-
DEFINE_COMMAND(CMySProcAccessor, _T("{ ? = SELECT phone FROM shippers WHERE name = ? }")
21+
DEFINE_COMMAND_EX(CMySProcAccessor, _T("{ ? = SELECT phone FROM shippers WHERE name = ? }"))
2222
```
2323
2424
You specify the in and out parameters in the parameter map:

‎docs/data/oledb/receiving-notifications.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Receiving Notifications | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "11/04/2016"
4+
ms.date: "10/24/2018"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
77
dev_langs: ["C++"]
@@ -23,9 +23,12 @@ The following code shows how to open the rowset from an ATL object and use the `
2323

2424
```cpp
2525
CDBPropSet propset(DBPROPSET_ROWSET);
26-
2726
propset.AddProperty(DBPROP_IConnectionPointContainer, true);
28-
27+
```
28+
29+
Then, used by the following code:
30+
31+
```cpp
2932
product.Open(session, _T("Products"), &propset);
3033
3134
AtlAdvise(product.m_spRowset, GetUnknown(), IID_IRowsetNotify, &m_dwCookie);

‎docs/data/oledb/retrieving-a-blob.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Retrieving a BLOB | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "11/04/2016"
4+
ms.date: "10/24/2018"
55
ms.technology: ["cpp-data"]
66
ms.topic: "reference"
77
dev_langs: ["C++"]
@@ -21,16 +21,20 @@ The following code shows how to retrieve a BLOB using `ISequentialStream`. The m
2121
class CCategories
2222
{
2323
public:
24-
ISequentialStream* pPicture;
24+
ISequentialStream* pPicture;
2525

2626
BEGIN_COLUMN_MAP(CCategories)
2727
BLOB_ENTRY(4, IID_ISequentialStream, STGM_READ, pPicture)
2828
END_COLUMN_MAP()
2929
};
30-
30+
```
31+
32+
Then, used by the following code:
33+
34+
```cpp
3135
CTable<CAccessor<CCategories>> categories;
32-
ULONG cb;
33-
BYTE myBuffer[65536];
36+
ULONG cb;
37+
BYTE myBuffer[65536];
3438
3539
categories.Open(session, "Categories");
3640
@@ -50,4 +54,4 @@ For more information about macros that handle BLOB data, see **Column Map Macros
5054
## See Also
5155

5256
[Using Accessors](../../data/oledb/using-accessors.md)<br/>
53-
[Macros and Global Functions for OLE DB Consumer Templates](../../data/oledb/macros-and-global-functions-for-ole-db-consumer-templates.md)
57+
[Macros and Global Functions for OLE DB Consumer Templates](../../data/oledb/macros-and-global-functions-for-ole-db-consumer-templates.md)<br/>

‎docs/data/oledb/updating-rowsets.md‎

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ You set the properties as follows:
3838
```cpp
3939
CDBPropSet ps(DBPROPSET_ROWSET);
4040

41-
ps.AddProperty(DBPROP_IRowsetChange, true)
42-
ps.AddProperty(DBPROP_UPDATABILITY, DBPROPVAL_UP_CHANGE | DBPROPVAL_UP_INSERT | DBPROPVAL_UP_DELETE)
41+
ps.AddProperty(DBPROP_IRowsetChange, true);
42+
ps.AddProperty(DBPROP_UPDATABILITY, DBPROPVAL_UP_CHANGE | DBPROPVAL_UP_INSERT | DBPROPVAL_UP_DELETE);
4343
```
4444
4545
Change, insert, or delete operations might fail if one or more columns isn't writable. Modify your cursor map to correct this issue.
@@ -58,8 +58,7 @@ product.Open(session, "Product", &ps, 1); // ps is the property set
5858
product.MoveToBookmark(&bookmark, 0); // Assume that bookmark is set to 100th row
5959
6060
// Change the values of columns "Name" and "Units in Stock" in the current row of the Product table
61-
_tcscpy_s(product.m_ProductName, product.m_sizeOfProductName,
62-
_T( "Candle" ) );
61+
_tcscpy_s(product.m_ProductName, product.m_sizeOfProductName, _T( "Candle" ) );
6362
6463
product.m_UnitsInStock = 10000;
6564
@@ -92,13 +91,11 @@ product.MoveToBookmark(&bookmark, 0); // Assume that bookmark is set to 100
9291
9392
// Set the column values for a row of the Product table, then insert the row
9493
product.m_ProductID = 101;
95-
_tcscpy_s(product.m_ProductName, product.m_sizeOfProductName,
96-
_T( "Candle" ) );
94+
_tcscpy_s(product.m_ProductName, product.m_sizeOfProductName, _T( "Candle" ) );
9795
9896
product.m_SupplierID = 27857;
9997
product.m_CategoryID = 372;
100-
_tcscpy_s(product.m_QuantityPerUnit, product.m_sizeOfQuantityPerUnit,
101-
_T( "Pack of 10" ) );
98+
_tcscpy_s(product.m_QuantityPerUnit, product.m_sizeOfQuantityPerUnit, _T( "Pack of 10" ) );
10299
103100
product.m_UnitPrice = 20;
104101
product.m_UnitsInStock = 10000;
@@ -179,8 +176,7 @@ product.Open(session, "Product", &ps, 1); // ps is the property set
179176
product.MoveToBookmark(&bookmark, 0); // Assume that bookmark is set to 100th row
180177
181178
// Change the values of columns "Name" and "Units in Stock" in the 100th row of the Product table
182-
_tcscpy_s(product.m_ProductName, product.m_sizeOfProductName,
183-
_T( "Wick" ) );
179+
_tcscpy_s(product.m_ProductName, product.m_sizeOfProductName, _T( "Wick" ) );
184180
185181
product.m_UnitsInStock = 10000;
186182
@@ -190,8 +186,7 @@ product.Update(); // Update row 100 now
190186
// Change the values of columns "Name" and "Units in Stock" in the 101st row of the Product table
191187
product.MoveNext();
192188
193-
_tcscpy_s(product.m_ProductName, product.m_sizeOfProductName
194-
_T( "Wax" ) );
189+
_tcscpy_s(product.m_ProductName, product.m_sizeOfProductName _T( "Wax" ) );
195190
196191
product.m_UnitsInStock = 500;
197192
@@ -209,4 +204,4 @@ Finally, one main reason to defer changes is to be able to undo them. Calling [C
209204

210205
[Working with OLE DB Consumer Templates](../../data/oledb/working-with-ole-db-consumer-templates.md)<br/>
211206
[CRowset Class](../../data/oledb/crowset-class.md)<br/>
212-
[IRowsetChange](/previous-versions/windows/desktop/ms715790)
207+
[IRowsetChange](/previous-versions/windows/desktop/ms715790)<br/>

0 commit comments

Comments
 (0)