Skip to content

Commit eacb49e

Browse files
authored
Merge pull request MicrosoftDocs#1040 from msebolt/format-atl-reference-pr8
format atl reference pr8
2 parents 56d152d + bcc3a7e commit eacb49e

23 files changed

+253
-252
lines changed

docs/atl/reference/object-status-macros.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This macro sets flags belonging to ActiveX controls.
1616

1717
|||
1818
|-|-|
19-
|[DECLARE_OLEMISC_STATUS](#declare_olemisc_status)|Used in ATL ActiveX controls to set the **OLEMISC** flags.|
19+
|[DECLARE_OLEMISC_STATUS](#declare_olemisc_status)|Used in ATL ActiveX controls to set the OLEMISC flags.|
2020

2121
## Requirements
2222
**Header:** atlcom.h

docs/atl/reference/options-atl-active-server-page-component-wizard.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Use this page of the ATL Active Server Page Component Wizard to design for incre
2424

2525
|Option|Description|
2626
|------------|-----------------|
27-
|`Single`|Specifies that the object uses the single threading model. In the single threading model, an object always runs in the primary COM thread. See [Single-Threaded Apartments](http://msdn.microsoft.com/library/windows/desktop/ms680112) and [InprocServer32](http://msdn.microsoft.com/library/windows/desktop/ms682390) for more information.|
27+
|**Single**|Specifies that the object uses the single threading model. In the single threading model, an object always runs in the primary COM thread. See [Single-Threaded Apartments](http://msdn.microsoft.com/library/windows/desktop/ms680112) and [InprocServer32](http://msdn.microsoft.com/library/windows/desktop/ms682390) for more information.|
2828
|**Apartment**|Specifies that the object uses apartment threading. Equivalent to single thread apartment. Each object of an apartment-threaded component is assigned an apartment for its thread, for the life of the object; however, multiple threads can be used for multiple objects. Each apartment is tied to a specific thread and has a Windows message pump (default).<br /><br /> See [Single-Threaded Apartments](http://msdn.microsoft.com/library/windows/desktop/ms680112) for more information.|
2929
|**Both**|Specifies that the object can use either apartment or free threading, depending from which kind of a thread it is created.|
3030
|**Free**|Specifies that the object uses free threading. Free threading is equivalent to a multithread apartment model. See [Multithreaded Apartments](http://msdn.microsoft.com/library/windows/desktop/ms693421) for more information.|
@@ -44,7 +44,7 @@ Use this page of the ATL Active Server Page Component Wizard to design for incre
4444

4545
|Option|Description|
4646
|------------|-----------------|
47-
|**ISupportErrorInfo**|Creates support for the [ISupportErrorInfo](../../atl/reference/isupporterrorinfoimpl-class.md) interface so the object can return error information to the client.|
47+
|`ISupportErrorInfo`|Creates support for the [ISupportErrorInfo](../../atl/reference/isupporterrorinfoimpl-class.md) interface so the object can return error information to the client.|
4848
|**Connection points**|Enables connection points for your object by making your object's class derive from [IConnectionPointContainerImpl](../../atl/reference/iconnectionpointcontainerimpl-class.md).|
4949
|**Free-threaded marshaler**|Creates a free-threaded marshaler object to marshal interface pointers efficiently between threads in the same process. Available to object specifying either **Both** or **Free** as the threading model.|
5050

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Insert "Search Results" summary here.
6969

7070
If you select **Custom**, then you can specify that the control is **Automation compatible**. If you select **Automation compatible**, then the wizard adds the [oleautomation](../../windows/oleautomation.md) attribute to the interface in the IDL, and the interface can be marshaled by the universal marshaler in oleaut32.dll. See [Marshaling Details](http://msdn.microsoft.com/library/windows/desktop/ms692621) in the Windows SDK for more information.
7171

72-
Additionally, if you select **Automation compatible**, then all parameters for all methods in the control must be **VARIANT** compatible.
72+
Additionally, if you select **Automation compatible**, then all parameters for all methods in the control must be VARIANT compatible.
7373

7474
**Support**
7575
Sets additional miscellaneous support for the control.

docs/atl/reference/options-atl-property-page-wizard.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Use this page of the wizard to define the threading model and aggregation level
2222

2323
|Option|Description|
2424
|------------|-----------------|
25-
|`Single`|The property page runs only in the primary COM thread.|
25+
|**Single**|The property page runs only in the primary COM thread.|
2626
|**Apartment**|The property page can be created in any single thread apartment. The default.|
2727

2828
**Aggregation**

docs/atl/reference/options-atl-simple-object-wizard.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Use this page of the ATL Simple Object Wizard to design for increased efficiency
2424

2525
|Option|Description|
2626
|------------|-----------------|
27-
|`Single`|Specifies that the object always runs in the primary COM thread. See [Single-Threaded Apartments](http://msdn.microsoft.com/library/windows/desktop/ms680112) and [InprocServer32](http://msdn.microsoft.com/library/windows/desktop/ms682390) for more information.|
27+
|**Single**|Specifies that the object always runs in the primary COM thread. See [Single-Threaded Apartments](http://msdn.microsoft.com/library/windows/desktop/ms680112) and [InprocServer32](http://msdn.microsoft.com/library/windows/desktop/ms682390) for more information.|
2828
|**Apartment**|Specifies that the object uses apartment threading. Equivalent to single thread apartment. Each object of an apartment-threaded component is assigned an apartment for its thread, for the life of the object; however, multiple threads can be used for multiple objects. Each apartment is tied to a specific thread and has a Windows message pump (default).<br /><br /> See [Single-Threaded Apartments](http://msdn.microsoft.com/library/windows/desktop/ms680112) for more information.|
2929
|**Both**|Specifies that the object can use either apartment or free threading, depending from which kind of a thread it is created.|
3030
|**Free**|Specifies that the object uses free threading. Free threading is equivalent to a multithread apartment model. See [Multithreaded Apartments](http://msdn.microsoft.com/library/windows/desktop/ms693421) for more information.|
@@ -52,10 +52,10 @@ Use this page of the ATL Simple Object Wizard to design for increased efficiency
5252

5353
|Option|Description|
5454
|------------|-----------------|
55-
|**ISupportErrorInfo**|Creates support for the [ISupportErrorInfo](../../atl/reference/isupporterrorinfoimpl-class.md) interface so the object can return error information to the client.|
55+
|`ISupportErrorInfo`|Creates support for the [ISupportErrorInfo](../../atl/reference/isupporterrorinfoimpl-class.md) interface so the object can return error information to the client.|
5656
|**Connection points**|Enables connection points for your object by making your object's class derive from [IConnectionPointContainerImpl](../../atl/reference/iconnectionpointcontainerimpl-class.md).|
5757
|**Free-threaded marshaler**|Creates a free-threaded marshaler object to marshal interface pointers efficiently between threads in the same process. Available to object specifying **Both** as the threading model.|
58-
|**IObjectWithSite (IE object support)**|Implements [IObjectWithSiteImpl](../../atl/reference/iobjectwithsiteimpl-class.md), which provides a simple way to support communication between an object and its site in a container.|
58+
|`IObjectWithSite` **(IE object support)**|Implements [IObjectWithSiteImpl](../../atl/reference/iobjectwithsiteimpl-class.md), which provides a simple way to support communication between an object and its site in a container.|
5959

6060
## See Also
6161
[ATL Simple Object Wizard](../../atl/reference/atl-simple-object-wizard.md)

docs/atl/reference/pixel-himetric-conversion-global-functions.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ extern void AtlHiMetricToPixel(
3333
```
3434

3535
### Parameters
36-
`lpSizeInHiMetric`
36+
*lpSizeInHiMetric*
3737
[in] Pointer to the size of the object in HIMETRIC units.
3838

39-
`lpSizeInPix`
39+
*lpSizeInPix*
4040
[out] Pointer to where the object's size in pixels is to be returned.
4141

4242
### Example
@@ -55,10 +55,10 @@ extern void AtlPixelToHiMetric(
5555
```
5656

5757
### Parameters
58-
`lpSizeInPix`
58+
*lpSizeInPix*
5959
[in] Pointer to the object's size in pixels.
6060

61-
`lpSizeInHiMetric`
61+
*lpSizeInHiMetric*
6262
[out] Pointer to where the object's size in HIMETRIC units is to be returned.
6363

6464
### Example

docs/atl/reference/property-map-macros.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ BEGIN_PROP_MAP(theClass)
3535
```
3636

3737
### Parameters
38-
`theClass`
38+
*theClass*
3939
[in] Specifies the class containing the property map.
4040

4141
### Remarks
4242
The property map stores property descriptions, property DISPIDs, property page CLSIDs, and `IDispatch` IIDs. Classes [IPerPropertyBrowsingImpl](../../atl/reference/iperpropertybrowsingimpl-class.md), [IPersistPropertyBagImpl](../../atl/reference/ipersistpropertybagimpl-class.md), [IPersistStreamInitImpl](../../atl/reference/ipersiststreaminitimpl-class.md), and [ISpecifyPropertyPagesImpl](../../atl/reference/ispecifypropertypagesimpl-class.md) use the property map to retrieve and set this information.
4343

44-
When you create an object with the ATL Project Wizard, the wizard will create an empty property map by specifying `BEGIN_PROP_MAP` followed by [END_PROP_MAP](#end_prop_map).
44+
When you create an object with the ATL Project Wizard, the wizard will create an empty property map by specifying BEGIN_PROP_MAP followed by [END_PROP_MAP](#end_prop_map).
4545

46-
`BEGIN_PROP_MAP` does not save out the extent (that is, the dimensions) of a property map, because an object using a property map may not have a user interface, so it would have no extent. If the object is an ActiveX control with a user interface, it has an extent. In this case, you must specify [PROP_DATA_ENTRY](#prop_data_entry) in your property map to supply the extent.
46+
BEGIN_PROP_MAP does not save out the extent (that is, the dimensions) of a property map, because an object using a property map may not have a user interface, so it would have no extent. If the object is an ActiveX control with a user interface, it has an extent. In this case, you must specify [PROP_DATA_ENTRY](#prop_data_entry) in your property map to supply the extent.
4747

4848
### Example
4949
[!code-cpp[NVC_ATL_Windowing#103](../../atl/codesnippet/cpp/property-map-macros_1.h)]
@@ -56,10 +56,10 @@ PROP_DATA_ENTRY( szDesc, member, vt)
5656
```
5757

5858
### Parameters
59-
`szDesc`
59+
*szDesc*
6060
[in] The property description.
6161

62-
`member`
62+
*member*
6363
[in] The data member containing the extent; for example, `m_sizeExtent`.
6464

6565
*vt*
@@ -71,7 +71,7 @@ PROP_DATA_ENTRY( szDesc, member, vt)
7171
When you create an ActiveX control, the wizard inserts this macro after the property map macro [BEGIN_PROP_MAP](#begin_prop_map) and before the property map macro [END_PROP_MAP](#end_prop_map).
7272

7373
### Example
74-
In the following example, the extent of the object ( `m_sizeExtent`) is being persisted.
74+
In the following example, the extent of the object (`m_sizeExtent`) is being persisted.
7575

7676
[!code-cpp[NVC_ATL_Windowing#131](../../atl/codesnippet/cpp/property-map-macros_2.h)]
7777

@@ -85,20 +85,20 @@ PROP_ENTRY_TYPE( szDesc, dispid, clsid, vt)
8585
```
8686

8787
### Parameters
88-
`szDesc`
88+
*szDesc*
8989
[in] The property description.
9090

91-
`dispid`
91+
*dispid*
9292
[in] The property's DISPID.
9393

94-
`clsid`
95-
[in] The CLSID of the associated property page. Use the special value `CLSID_NULL` for a property that does not have an associated property page.
94+
*clsid*
95+
[in] The CLSID of the associated property page. Use the special value CLSID_NULL for a property that does not have an associated property page.
9696

97-
`vt`
97+
*vt*
9898
[in] The property's type.
9999

100100
### Remarks
101-
The `PROP_ENTRY` macro was insecure and deprecated. It has been replaced with `PROP_ENTRY_TYPE`.
101+
The PROP_ENTRY macro was insecure and deprecated. It has been replaced with PROP_ENTRY_TYPE.
102102

103103
The [BEGIN_PROP_MAP](#begin_prop_map) macro marks the beginning of the property map; the [END_PROP_MAP](#end_prop_map) macro marks the end.
104104

@@ -113,23 +113,23 @@ PROP_ENTRY_TYPE_EX( szDesc, dispid, clsid, iidDispatch, vt)
113113
```
114114

115115
### Parameters
116-
`szDesc`
116+
*szDesc*
117117
[in] The property description.
118118

119-
`dispid`
119+
*dispid*
120120
[in] The property's DISPID.
121121

122-
`clsid`
123-
[in] The CLSID of the associated property page. Use the special value `CLSID_NULL` for a property that does not have an associated property page.
122+
*clsid*
123+
[in] The CLSID of the associated property page. Use the special value CLSID_NULL for a property that does not have an associated property page.
124124

125-
`iidDispatch`
125+
*iidDispatch*
126126
[in] The IID of the dual interface defining the property.
127127

128-
`vt`
128+
*vt*
129129
[in] The property's type.
130130

131131
### Remarks
132-
The `PROP_ENTRY_EX` macro was insecure and deprecated. It has been replaced with `PROP_ENTRY_TYPE_EX`.
132+
The PROP_ENTRY_EX macro was insecure and deprecated. It has been replaced with PROP_ENTRY_TYPE_EX.
133133

134134
The [BEGIN_PROP_MAP](#begin_prop_map) macro marks the beginning of the property map; the [END_PROP_MAP](#end_prop_map) macro marks the end.
135135

@@ -146,14 +146,14 @@ PROP_PAGE(clsid)
146146
```
147147

148148
### Parameters
149-
`clsid`
149+
*clsid*
150150
[in] The CLSID of a property page.
151151

152152
### Remarks
153-
`PROP_PAGE` is similar to [PROP_ENTRY_TYPE](#prop_entry_type), but does not require a property description or DISPID.
153+
PROP_PAGE is similar to [PROP_ENTRY_TYPE](#prop_entry_type), but does not require a property description or DISPID.
154154

155155
> [!NOTE]
156-
> If you have already entered a CLSID with `PROP_ENTRY_TYPE` or [PROP_ENTRY_TYPE_EX](#prop_entry_type_ex), you do not need to make an additional entry with `PROP_PAGE`.
156+
> If you have already entered a CLSID with PROP_ENTRY_TYPE or [PROP_ENTRY_TYPE_EX](#prop_entry_type_ex), you do not need to make an additional entry with PROP_PAGE.
157157
158158
The [BEGIN_PROP_MAP](#begin_prop_map) macro marks the beginning of the property map; the [END_PROP_MAP](#end_prop_map) macro marks the end.
159159

@@ -168,7 +168,7 @@ END_PROP_MAP()
168168
```
169169

170170
### Remarks
171-
When you create an object with the ATL Project Wizard, the wizard will create an empty property map by specifying [BEGIN_PROP_MAP](#begin_prop_map) followed by `END_PROP_MAP`.
171+
When you create an object with the ATL Project Wizard, the wizard will create an empty property map by specifying [BEGIN_PROP_MAP](#begin_prop_map) followed by END_PROP_MAP.
172172

173173
### Example
174174
See the example for [BEGIN_PROP_MAP](#begin_prop_map).

0 commit comments

Comments
 (0)