Skip to content

Commit 41c8b48

Browse files
author
mtx48109
committed
format cleanup pr3
1 parent ca8692c commit 41c8b48

30 files changed

+205
-204
lines changed

docs/atl-mfc-shared/reference/ctime-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ bool GetAsSystemTime(SYSTEMTIME& st) const throw();
269269
A reference to a [SYSTEMTIME](http://msdn.microsoft.com/library/windows/desktop/ms724950) structure that will hold the converted date/time value of the `CTime` object.
270270

271271
### Return Value
272-
True if successful; otherwise false.
272+
TRUE if successful; otherwise FALSE.
273273

274274
### Remarks
275275
`GetAsSystemTime` stores the resulting time in the referenced *timeDest* structure. The `SYSTEMTIME` data structure initialized by this function will have its `wMilliseconds` member set to zero.

docs/atl-mfc-shared/using-cstring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ The topics in this section describe how to program with `CString`. For reference
1818

1919
The `CString`, `CStringA`, and `CStringW` classes are specializations of a class template called [CStringT](../atl-mfc-shared/reference/cstringt-class.md) based on the type of character data they support.
2020

21-
A `CStringW` object contains the `wchar_t` type and supports Unicode strings. A `CStringA` object contains the **char** type, and supports single-byte and multi-byte (MBCS) strings. A `CString` object supports either the **char** type or the `wchar_t` type, depending on whether the MBCS symbol or the UNICODE symbol is defined at compile time.
21+
A `CStringW` object contains the **wchar_t** type and supports Unicode strings. A `CStringA` object contains the **char** type, and supports single-byte and multi-byte (MBCS) strings. A `CString` object supports either the **char** type or the `wchar_t` type, depending on whether the MBCS symbol or the UNICODE symbol is defined at compile time.
2222

23-
A `CString` object keeps character data in a `CStringData` object. `CString` accepts `null`-terminated C-style strings. `CString` tracks the string length for faster performance, but it also retains the **null** character in the stored character data to support conversion to LPCWSTR. `CString` includes the null terminator when it exports a C-style string. You can insert a **null** at other locations in a `CString`, but it may produce unexpected results.
23+
A `CString` object keeps character data in a `CStringData` object. `CString` accepts NULL-terminated C-style strings. `CString` tracks the string length for faster performance, but it also retains the NULL character in the stored character data to support conversion to LPCWSTR. `CString` includes the null terminator when it exports a C-style string. You can insert a NULL at other locations in a `CString`, but it may produce unexpected results.
2424

2525
The following set of string classes can be used without linking an MFC library, with or without CRT support: `CAtlString`, `CAtlStringA`, and `CAtlStringW`.
2626

docs/atl/atl-event-handling-summary.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ In general, handling COM events is a relatively simple process. There are three
3636
There are three main ways of advising and unadvising an event source using ATL.
3737

3838
|Advise function|Unadvise function|Most suitable for use with|Requires you to keep track of a cookie|Comments|
39-
|---------------------|-----------------------|--------------------------------|---------------------------------------------|--------------|
39+
|---------------------|-----------------------|--------------------------------|---------------------------------------------|--------------|
40+
| | | | | |
4041

4142
|[AtlAdvise](reference/connection-point-global-functions.md#atladvise), [CComPtrBase::Advise](../atl/reference/ccomptrbase-class.md#advise)|[AtlUnadvise](reference/connection-point-global-functions.md#atlunadvise)|Vtable or dual interfaces|Yes|`AtlAdvise` is a global ATL function. `CComPtrBase::Advise` is used by [CComPtr](../atl/reference/ccomptr-class.md) and [CComQIPtr](../atl/reference/ccomqiptr-class.md).|
4243

docs/atl/creating-the-project-atl-tutorial-part-1.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,17 @@ This tutorial walks you step-by-step through a nonattributed ATL project that cr
3939

4040
The ATL Project Wizard will create the project by generating several files. You can view these files in Solution Explorer by expanding the Polygon object. The files are listed below.
4141

42-
|File|Description|
43-
|----------|-----------------|
44-
|Polygon.cpp|Contains the implementation of `DllMain`, `DllCanUnloadNow`, `DllGetClassObject`, `DllRegisterServer`, and `DllUnregisterServer`. Also contains the object map, which is a list of the ATL objects in your project. This is initially blank.|
45-
|Polygon.def|This module-definition file provides the linker with information about the exports required by your DLL.|
46-
|Polygon.idl|The interface definition language file, which describes the interfaces specific to your objects.|
47-
|Polygon.rgs|This registry script contains information for registering your program's DLL.|
48-
|Polygon.rc|The resource file, which initially contains the version information and a string containing the project name.|
49-
|Resource.h|The header file for the resource file.|
50-
|Polygonps.def|This module definition file provides the linker with information about the exports required by the proxy and stub code that support calls across apartments.|
51-
|stdafx.cpp|The file that will `#include` the ATL implementation files.|
52-
|stdafx.h|The file that will `#include` the ATL header files.|
42+
|File|Description|
43+
|----------|-----------------|
44+
|Polygon.cpp|Contains the implementation of `DllMain`, `DllCanUnloadNow`, `DllGetClassObject`, `DllRegisterServer`, and `DllUnregisterServer`. Also contains the object map, which is a list of the ATL objects in your project. This is initially blank.|
45+
|Polygon.def|This module-definition file provides the linker with information about the exports required by your DLL.|
46+
|Polygon.idl|The interface definition language file, which describes the interfaces specific to your objects.|
47+
|Polygon.rgs|This registry script contains information for registering your program's DLL.|
48+
|Polygon.rc|The resource file, which initially contains the version information and a string containing the project name.|
49+
|Resource.h|The header file for the resource file.|
50+
|Polygonps.def|This module definition file provides the linker with information about the exports required by the proxy and stub code that support calls across apartments.|
51+
|stdafx.cpp|The file that will `#include` the ATL implementation files.|
52+
|stdafx.h|The file that will `#include` the ATL header files.|
5353

5454
1. In Solution Explorer, right-click the `Polygon` project.
5555

docs/atl/hosting-activex-controls-using-atl-axhost.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The sample in this topic shows how to create AXHost and how to host an ActiveX c
2020

2121
- For values of USE_METHOD between 1 and 4, access to the control and sinking of events are accomplished in the call that also creates the host. Values between 5 and 8 query the host for interfaces and hook the sink.
2222

23-
Here's a summary:
23+
Here's a summary:
2424

2525
|USE_METHOD|Host|Control access and event sinking|Function demonstrated|
2626
|-----------------|----------|--------------------------------------|---------------------------|

docs/atl/reference/appearance-atl-control-wizard.md

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -21,71 +21,70 @@ Insert "Search Results" summary here.
2121
**View status**
2222
Sets the appearance of the control within the container.
2323

24-
- **Opaque**: Sets the VIEWSTATUS_OPAQUE bit in the [VIEWSTATUS](http://msdn.microsoft.com/library/windows/desktop/ms687201) enumeration and draws the entire control rectangle passed to the [CComControlBase::OnDraw](../../atl/reference/ccomcontrolbase-class.md#ondraw) method. The control appears completely opaque, and none of the container shows behind the control boundaries.
25-
26-
This setting helps the container draw the control more quickly. If this option is not selected, the control can contain transparent parts.
27-
28-
Only an opaque control can have a solid background.
29-
30-
- Sets the VIEWSTATUS_SOLIDBKGND bit in the VIEWSTATUS enumeration. The control's background appears as a solid color with no pattern.
31-
32-
This option is available only if the **Opaque** option is also selected.
24+
- **Opaque**: Sets the VIEWSTATUS_OPAQUE bit in the [VIEWSTATUS](http://msdn.microsoft.com/library/windows/desktop/ms687201) enumeration and draws the entire control rectangle passed to the [CComControlBase::OnDraw](../../atl/reference/ccomcontrolbase-class.md#ondraw) method. The control appears completely opaque, and none of the container shows behind the control boundaries.
25+
26+
This setting helps the container draw the control more quickly. If this option is not selected, the control can contain transparent parts.
27+
28+
Only an opaque control can have a solid background.
29+
30+
- Sets the VIEWSTATUS_SOLIDBKGND bit in the VIEWSTATUS enumeration. The control's background appears as a solid color with no pattern.
31+
32+
This option is available only if the **Opaque** option is also selected.
3333

3434
**Add control based on**
3535
Sets the control to be based on a Windows control type by adding a [CContainedWindow](ccontainedwindowt-class.md) data member to the class implementing the control. It also adds a message map and message handler functions to handle Windows messages for the control. Choose from the list the type of Windows control you want to create, if any.
3636

37-
38-
- `Button`
39-
40-
- `ListBox`
41-
42-
- `SysAnimate32`
43-
44-
- `SysListView32`
45-
46-
- `ComboBox`
47-
48-
- `RichEdit`
49-
50-
- `SysDateTimePick32`
51-
52-
- `SysMonthCal32`
53-
54-
- `ComboBoxEx32`
55-
56-
- `ScrollBar`
57-
58-
- `SysHeader32`
59-
60-
- `SysTabControl32`
61-
62-
- `Edit`
63-
64-
- `Static`
65-
66-
- `SysIPAddress32`
67-
68-
- `SysTreeView32`
37+
- `Button`
38+
39+
- `ListBox`
40+
41+
- `SysAnimate32`
42+
43+
- `SysListView32`
44+
45+
- `ComboBox`
46+
47+
- `RichEdit`
48+
49+
- `SysDateTimePick32`
50+
51+
- `SysMonthCal32`
52+
53+
- `ComboBoxEx32`
54+
55+
- `ScrollBar`
56+
57+
- `SysHeader32`
58+
59+
- `SysTabControl32`
60+
61+
- `Edit`
62+
63+
- `Static`
64+
65+
- `SysIPAddress32`
66+
67+
- `SysTreeView32`
6968

7069
**Misc status**
7170
Sets additional appearance and behavior options for the control.
7271

73-
- **Invisible at run-time**: Sets the control to be invisible at run time. You can use invisible controls to perform operations in the background, such as firing events at timed intervals.
74-
75-
- **Acts like button**: Sets the OLEMISC_ACTSLIKEBUTTON bit in the [OLEMISC](http://msdn.microsoft.com/library/windows/desktop/ms678497) enumeration to enable a control to act like a button. If the container has marked the control's client site as a default button, selecting this option enables your button control to display itself as a default button by drawing itself with a thicker frame. See [CComControlBase::GetAmbientDisplayAsDefault](../../atl/reference/ccomcontrolbase-class.md#getambientdisplayasdefault) for more information.
76-
77-
- **Acts like label**: Sets the OLEMISC_ACTSLIKELABEL bit in the OLEMISC enumeration to enable a control to replace the container's native label. The container determines what to do with this flag, if anything.
72+
- **Invisible at run-time**: Sets the control to be invisible at run time. You can use invisible controls to perform operations in the background, such as firing events at timed intervals.
73+
74+
- **Acts like button**: Sets the OLEMISC_ACTSLIKEBUTTON bit in the [OLEMISC](http://msdn.microsoft.com/library/windows/desktop/ms678497) enumeration to enable a control to act like a button. If the container has marked the control's client site as a default button, selecting this option enables your button control to display itself as a default button by drawing itself with a thicker frame. See [CComControlBase::GetAmbientDisplayAsDefault](../../atl/reference/ccomcontrolbase-class.md#getambientdisplayasdefault) for more information.
75+
76+
- **Acts like label**: Sets the OLEMISC_ACTSLIKELABEL bit in the OLEMISC enumeration to enable a control to replace the container's native label. The container determines what to do with this flag, if anything.
7877

7978
**Other**
8079
Sets additional behavior options for the control.
8180

82-
- **Normalized DC**: Sets the control to create a normalized device context when it is called to draw itself. This action standardizes the control's appearance, but it makes drawing less efficient.
83-
84-
- **Window only**: Specifies that your control cannot be windowless. If you do not select this option, your control is automatically windowless in containers that support windowless objects, and it is automatically windowed in containers that do not support windowless objects. Selecting this option forces your control to be windowed, even in containers that support windowless objects.
85-
86-
- **Insertable**: Select this option to have your control appear in the **Insert Object** dialog box of applications such as Word and Excel. Your control can then be inserted by any application that supports embedded objects through this dialog box.
81+
- **Normalized DC**: Sets the control to create a normalized device context when it is called to draw itself. This action standardizes the control's appearance, but it makes drawing less efficient.
82+
83+
- **Window only**: Specifies that your control cannot be windowless. If you do not select this option, your control is automatically windowless in containers that support windowless objects, and it is automatically windowed in containers that do not support windowless objects. Selecting this option forces your control to be windowed, even in containers that support windowless objects.
84+
85+
- **Insertable**: Select this option to have your control appear in the **Insert Object** dialog box of applications such as Word and Excel. Your control can then be inserted by any application that supports embedded objects through this dialog box.
8786

8887
## See Also
8988
[ATL Control Wizard](../../atl/reference/atl-control-wizard.md)
90-
[SUBEDIT Sample: Superclasses a Standard Windows Control](http://msdn.microsoft.com/en-us/30e46bdc-ed92-417c-b6b8-359017265a7b)
89+
[SUBEDIT Sample: Superclasses a Standard Windows Control](http://msdn.microsoft.com/30e46bdc-ed92-417c-b6b8-359017265a7b)
9190

docs/atl/reference/atl-http-utility-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ inline BOOL AtlEscapeUrl(
139139
### Return Value
140140
Returns TRUE on success, FALSE on failure.
141141

142-
## <a name="atlgetdefaulturlport"></a>
142+
## <a name="atlgetdefaulturlport"></a> AtlGetDefaultUrlPort
143143
Call this function to get the default port number associated with a particular Internet protocol or scheme.
144144

145145
```

docs/atl/reference/atl-ole-db-consumer-wizard.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This wizard sets up an OLE DB consumer class with the data bindings necessary to
4040
Click **OK** to finish. The **Select Database Object** dialog box appears. From this dialog box, select the table, view, or stored procedure that the consumer will use.
4141

4242
**Provider**
43-
Select an appropriate provider to manage the connection to the data source. The type of provider is typically determined by the type of database to which you are connecting. Click the `Next` button or click the **Connection** tab.
43+
Select an appropriate provider to manage the connection to the data source. The type of provider is typically determined by the type of database to which you are connecting. Click the **Next** button or click the **Connection** tab.
4444

4545
**Connection**
4646
The contents of this tab depend on the provider you selected. Although there are many types of providers, this section covers connections for the two most common: SQL and ODBC data. The others are similar variations on the fields described here.
@@ -104,21 +104,21 @@ This wizard sets up an OLE DB consumer class with the data bindings necessary to
104104
**Attributed**
105105
This option specifies whether the wizard will create consumer classes using attributes or template declarations. When you select this option, the wizard uses attributes instead of template declarations (this is the default option). When you deselect this option, the wizard uses template declarations instead of attributes.
106106

107-
- If you select a consumer **Type** of Table, the wizard uses the `db_source` and `db_table` attributes to create the table and table accessor class declarations, and uses **db_column** to create the column map, for example:
107+
- If you select a consumer **Type** of Table, the wizard uses the `db_source` and `db_table` attributes to create the table and table accessor class declarations, and uses `db_column` to create the column map, for example:
108108

109-
```
109+
```
110110
// Inject table class and table accessor class declarations
111111
[db_source("<initialization_string>"), db_table("dbo.Orders")]
112112
...
113113
// Column map
114114
[ db_column(1, status=m_dwOrderIDStatus, length=m_dwOrderIDLength) ] LONG m_OrderID;
115115
[ db_column(2, status=m_dwCustomerIDStatus, length=m_dwCustomerIDLength) ] TCHAR m_CustomerID[6];
116-
...
117-
```
116+
...
117+
```
118118

119119
instead of using the `CTable` template class to declare the table and table accessor class, and the BEGIN_COLUMN_MAP and END_COLUMN_MAP macros to create the column map, for example:
120120

121-
```
121+
```
122122
// Table accessor class
123123
class COrdersAccessor; // Table class
124124
class COrders : public CTable<CAccessor<COrdersAccessor>>;
@@ -129,27 +129,27 @@ This wizard sets up an OLE DB consumer class with the data bindings necessary to
129129
COLUMN_ENTRY_LENGTH_STATUS(2, m_CustomerID, m_dwCustomerIDLength, m_dwCustomerIDStatus)
130130
...
131131
END_COLUMN_MAP()
132-
```
132+
```
133133

134134
- If you select a consumer **Type** of Command, the wizard uses the `db_source` and `db_command` attributes, and uses `db_column` to create the column map, for example:
135135

136-
```
136+
```
137137
[db_source("<initialization_string>"), db_command("SQL_command")]
138138
...
139139
// Column map using db_column is the same as for consumer type of 'table'
140-
```
140+
```
141141

142142
instead of using the command and command accessor class declarations in the command class' .h file, for example:
143143

144-
```
144+
```
145145
Command accessor class:
146146
class CListOrdersAccessor;
147147
Command class:
148148
class CListOrders : public CCommand<CAccessor<CListOrdersAccessor>>;
149149
...
150150
// Column map using BEGIN_COLUMN_MAP ... END_COLUMN_MAP is the same as
151151
// for consumer type of 'table'
152-
```
152+
```
153153

154154
See [Basic Mechanics of Attributes](../../windows/basic-mechanics-of-attributes.md) for more information.
155155

docs/atl/reference/atl-path-functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ inline BOOL Canonicalize(wchar_t* pszDest, const wchar_t* pszSrc);
151151

152152

153153
## <a name="combine"></a> ATLPath::Combine
154-
This function is an overloaded wrapper for [PathCombine](https://msdn.microsoft.com/en-us/library/windows/desktop/bb773571).
154+
This function is an overloaded wrapper for [PathCombine](https://msdn.microsoft.com/library/windows/desktop/bb773571).
155155

156156
### Syntax
157157
```
@@ -306,7 +306,7 @@ inline int GetDriveNumber(const wchar_t* pszPath);
306306

307307

308308
## <a name="isdirectory"></a> ATLPath::IsDirectory
309-
This function is an overloaded wrapper for [PathIsDirectory](https://msdn.microsoft.com/en-us/library/windows/desktop/bb773621).
309+
This function is an overloaded wrapper for [PathIsDirectory](https://msdn.microsoft.com/library/windows/desktop/bb773621).
310310

311311
```
312312
inline BOOL IsDirectory(const char* pszPath);

0 commit comments

Comments
 (0)