Skip to content

Commit 46a7a6c

Browse files
author
mtx48109
committed
format mfc reference pr1
1 parent a461110 commit 46a7a6c

30 files changed

+679
-679
lines changed

‎docs/mfc/reference/add-class-from-typelib-wizard.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ Use this wizard to add an MFC class from an available type library. The wizard c
4242
|**<\<**|Removes all the classes in the **Generated classes** list. Dimmed if the **Generated classes** list is empty.|
4343

4444
**Generated classes**
45-
Specifies the class names to be generated from the interfaces added using the **>** or **>>** button. You can click this box to select a class, and then use the up or down keys to scroll through the list, viewing each class name in the `Class` box and file name in the **File** box that the wizard generates when you click **Finish**. You can select only one class at a time in this box.
45+
Specifies the class names to be generated from the interfaces added using the **>** or **>>** button. You can click this box to select a class, and then use the up or down keys to scroll through the list, viewing each class name in the **Class** box and file name in the **File** box that the wizard generates when you click **Finish**. You can select only one class at a time in this box.
4646

4747
You can remove a class by selecting it in this list and clicking **<**. You do not need to select a class in the Generated classes box to remove all classes; by clicking **<<**, you remove all classes in the **Generated classes** box.
4848

49-
`Class`
50-
Specifies the name of the class selected in the **Generated classes** box that the wizard adds when you click **Finish**. You can edit the name in the `Class` box.
49+
**Class**
50+
Specifies the name of the class selected in the **Generated classes** box that the wizard adds when you click **Finish**. You can edit the name in the **Class** box.
5151

5252
**File**
5353
Sets the name of the header file for the new class. By default, this name is based on the name you provide in **Generated classes**. Click the ellipsis button to save the file name to the location of your choice, or to append the class declaration to an existing file. If you choose an existing file, the wizard will not save it to the selected location until you click **Finish** in the wizard.

‎docs/mfc/reference/afx-extension-module-structure.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ struct AFX_EXTENSION_MODULE
3232
*bInitialized*
3333
**TRUE** if the DLL module has been initialized with `AfxInitExtensionModule`.
3434

35-
`hModule`
35+
*hModule*
3636
Specifies the handle of the DLL module.
3737

3838
*hResource*
@@ -49,13 +49,13 @@ struct AFX_EXTENSION_MODULE
4949

5050
- Call [AfxInitExtensionModule](extension-dll-macros.md#afxinitextensionmodule) and check the return value.
5151

52-
- Create a **CDynLinkLibrary** object if the DLL will be exporting [CRuntimeClass](../../mfc/reference/cruntimeclass-structure.md) objects or has its own custom resources.
52+
- Create a `CDynLinkLibrary` object if the DLL will be exporting [CRuntimeClass](../../mfc/reference/cruntimeclass-structure.md) objects or has its own custom resources.
5353

5454
The `AFX_EXTENSION_MODULE` structure is used to hold a copy of the MFC extension DLL module state, including a copy of the runtime class objects that have been initialized by the MFC extension DLL as part of normal static object construction executed before `DllMain` is entered. For example:
5555

5656
[!code-cpp[NVC_MFC_DLL#2](../../atl-mfc-shared/codesnippet/cpp/afx-extension-module-structure_1.cpp)]
5757

58-
The module information stored in the `AFX_EXTENSION_MODULE` structure can be copied into the **CDynLinkLibrary** object. For example:
58+
The module information stored in the `AFX_EXTENSION_MODULE` structure can be copied into the `CDynLinkLibrary` object. For example:
5959

6060
[!code-cpp[NVC_MFC_DLL#5](../../atl-mfc-shared/codesnippet/cpp/afx-extension-module-structure_2.cpp)]
6161

‎docs/mfc/reference/afx-global-data-structure.md‎

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,13 @@ HRESULT D2D1MakeRotateMatrix(
136136
```
137137

138138
### Parameters
139-
`angle`
139+
*angle*
140140
The clockwise rotation angle, in degrees.
141141

142-
`center`
142+
*center*
143143
The point about which to rotate.
144144

145-
`matrix`
145+
*matrix*
146146
When this method returns, contains the new rotation transformation. You must allocate storage for this parameter.
147147

148148
### Return Value
@@ -160,13 +160,13 @@ BOOL DrawParentBackground(
160160
```
161161

162162
### Parameters
163-
[in] `pWnd`
163+
[in] *pWnd*
164164
Pointer to a control's window.
165165

166-
[in] `pDC`
166+
[in] *pDC*
167167
Pointer to a device context.
168168

169-
[in] `lpRect`
169+
[in] *lpRect*
170170
Pointer to a rectangle that bounds the area to draw. The default value is `NULL`.
171171

172172
### Return Value
@@ -190,42 +190,42 @@ BOOL DrawTextOnGlass(
190190
```
191191

192192
### Parameters
193-
[in] `hTheme`
193+
[in] *hTheme*
194194
Handle to the theme data of a window, or `NULL`. The framework uses the specified theme to draw the text if this parameter is not `NULL` and themes are supported. Otherwise, the framework does not use a theme to draw the text.
195195

196196
Use the [OpenThemeData](http://msdn.microsoft.com/library/windows/desktop/bb759821) method to create an `HTHEME`.
197197

198-
[in] `pDC`
198+
[in] *pDC*
199199
Pointer to a device context.
200200

201-
[in] `iPartId`
201+
[in] *iPartId*
202202
The control part that has the desired text appearance. For more information, see the Parts column of the table in [Parts and States](http://msdn.microsoft.com/library/windows/desktop/bb773210). If this value is 0, the text is drawn in the default font, or a font selected into the device context.
203203

204-
[in] `iStateId`
204+
[in] *iStateId*
205205
The control state that has the desired text appearance. For more information, see the States column of the table in [Parts and States](http://msdn.microsoft.com/library/windows/desktop/bb773210).
206206

207-
[in] `strText`
207+
[in] *strText*
208208
The text to draw.
209209

210-
[in] `rect`
210+
[in] *rect*
211211
The boundary of the area in which the specified text is drawn.
212212

213-
[in] `dwFlags`
213+
[in] *dwFlags*
214214
A bitwise combination (OR) of flags that specify how the specified text is drawn.
215215

216-
If the `hTheme` parameter is `NULL` or if themes are not supported and enabled, the `nFormat` parameter of the [CDC::DrawText](../../mfc/reference/cdc-class.md#drawtext) method describes the valid flags. If themes are supported, the `dwFlags` parameter of the [DrawThemeTextEx](http://msdn.microsoft.com/library/windows/desktop/bb773317) method describes the valid flags.
216+
If the *hTheme* parameter is `NULL` or if themes are not supported and enabled, the *nFormat* parameter of the [CDC::DrawText](../../mfc/reference/cdc-class.md#drawtext) method describes the valid flags. If themes are supported, the *dwFlags* parameter of the [DrawThemeTextEx](http://msdn.microsoft.com/library/windows/desktop/bb773317) method describes the valid flags.
217217

218-
[in] `nGlowSize`
218+
[in] *nGlowSize*
219219
The size of a glow effect that is drawn on the background before drawing the specified text. The default value is 0.
220220

221-
[in] `clrText`
221+
[in] *clrText*
222222
The color in which the specified text is drawn. The default value is the default color.
223223

224224
### Return Value
225225
`TRUE` if a theme is used to draw the specified text; otherwise, `FALSE`.
226226

227227
### Remarks
228-
A theme defines the visual style of an application. A theme is not used to draw the text if the `hTheme` parameter is `NULL`, or if the [DrawThemeTextEx](http://msdn.microsoft.com/library/windows/desktop/bb773317) method is not supported, or if [Desktop Window Manager](http://msdn.microsoft.com/library/windows/desktop/aa969540) (DWM) composition is disabled.
228+
A theme defines the visual style of an application. A theme is not used to draw the text if the *hTheme* parameter is `NULL`, or if the [DrawThemeTextEx](http://msdn.microsoft.com/library/windows/desktop/bb773317) method is not supported, or if [Desktop Window Manager](http://msdn.microsoft.com/library/windows/desktop/aa969540) (DWM) composition is disabled.
229229

230230
### See Also
231231
[Hierarchy Chart](../../mfc/hierarchy-chart.md)
@@ -245,7 +245,7 @@ void EnableAccessibilitySupport(BOOL bEnable=TRUE);
245245
```
246246

247247
### Parameters
248-
[in] `bEnable`
248+
[in] *bEnable*
249249
`TRUE` to enable accessibility support; `FALSE` to disable accessibility support. The default value is `TRUE`.
250250

251251
### Remarks
@@ -271,25 +271,25 @@ BOOL ExcludeTag(
271271
```
272272

273273
### Parameters
274-
[in] `strBuffer`
274+
[in] *strBuffer*
275275
A buffer of text.
276276

277-
[in] `lpszTag`
277+
[in] *lpszTag*
278278
The name of a pair of opening and closing XML tags.
279279

280-
[out] `strTag`
281-
When this method returns, the `strTag` parameter contains the text that is between the opening and closing XML tags that are named by the `lpszTag` parameter. Any leading or trailing whitespace is trimmed from the result.
280+
[out] *strTag*
281+
When this method returns, the *strTag* parameter contains the text that is between the opening and closing XML tags that are named by the *lpszTag* parameter. Any leading or trailing whitespace is trimmed from the result.
282282

283-
[in] `bIsCharsList`
284-
`TRUE` to convert symbols for escape characters in the `strTag` parameter into actual escape characters; `FALSE` not to perform the conversion.The default value is `FALSE`. For more information, see Remarks.
283+
[in] *bIsCharsList*
284+
`TRUE` to convert symbols for escape characters in the *strTag* parameter into actual escape characters; `FALSE` not to perform the conversion.The default value is `FALSE`. For more information, see Remarks.
285285

286286
### Return Value
287287
`TRUE` if this method is successful; otherwise, `FALSE`.
288288

289289
### Remarks
290-
An XML tag pair consists of named opening and closing tags that indicate the start and end of a run of text in the specified buffer. The `strBuffer` parameter specifies the buffer, and the `lpszTag` parameter specifies the name of the XML tags.
290+
An XML tag pair consists of named opening and closing tags that indicate the start and end of a run of text in the specified buffer. The *strBuffer* parameter specifies the buffer, and the *lpszTag* parameter specifies the name of the XML tags.
291291

292-
Use the symbols in the following table to encode a set of escape characters in the specified buffer. Specify `TRUE` for the `bIsCharsList` parameter to convert the symbols in the `strTag` parameter into actual escape characters. The following table uses the [_T()](../../c-runtime-library/data-type-mappings.md) macro to specify the symbol and escape character strings.
292+
Use the symbols in the following table to encode a set of escape characters in the specified buffer. Specify `TRUE` for the *bIsCharsList* parameter to convert the symbols in the *strTag* parameter into actual escape characters. The following table uses the [_T()](../../c-runtime-library/data-type-mappings.md) macro to specify the symbol and escape character strings.
293293

294294
|Symbol|Escape character|
295295
|------------|----------------------|
@@ -310,14 +310,14 @@ COLORREF GetColor(int nColor);
310310
```
311311

312312
### Parameters
313-
[in] `nColor`
314-
A value that specifies a user interface element whose color is retrieved. For a list of valid values, see the `nIndex` parameter of the [GetSysColor](http://msdn.microsoft.com/library/windows/desktop/ms724371) method.
313+
[in] *nColor*
314+
A value that specifies a user interface element whose color is retrieved. For a list of valid values, see the *nIndex* parameter of the [GetSysColor](http://msdn.microsoft.com/library/windows/desktop/ms724371) method.
315315

316316
### Return Value
317317
The RGB color value of the specified user interface element. For more information, see Remarks.
318318

319319
### Remarks
320-
If the `nColor` parameter is out of range, the return value is zero. Because zero is also a valid RGB value, you cannot use this method to determine whether a system color is supported by the current operating system. Instead, use the [GetSysColorBrush](http://msdn.microsoft.com/library/windows/desktop/dd144927) method, which returns `NULL` if the color is not supported.
320+
If the *nColor* parameter is out of range, the return value is zero. Because zero is also a valid RGB value, you cannot use this method to determine whether a system color is supported by the current operating system. Instead, use the [GetSysColorBrush](http://msdn.microsoft.com/library/windows/desktop/dd144927) method, which returns `NULL` if the color is not supported.
321321

322322
### See Also
323323

@@ -356,7 +356,7 @@ BOOL GetNonClientMetrics(NONCLIENTMETRICS& info);
356356
```
357357

358358
### Parameters
359-
[in, out] `info`
359+
[in, out] *info*
360360
A [NONCLIENTMETRICS](http://msdn.microsoft.com/library/windows/desktop/ff729175) structure that contains the scalable metrics associated with the nonclient area of a nonminimized window.
361361

362362
### Return Value
@@ -375,7 +375,7 @@ int GetTextHeight(BOOL bHorz = TRUE);
375375
```
376376

377377
### Parameters
378-
[in] `bHorz`
378+
[in] *bHorz*
379379
`TRUE` to retrieve the height of characters when text runs horizontally; `FALSE` to retrieve the height of characters when text runs vertically. The default value is `TRUE`.
380380

381381
### Return Value
@@ -414,10 +414,10 @@ BOOL InitD2D(
414414
```
415415

416416
### Parameters
417-
`d2dFactoryType`
417+
*d2dFactoryType*
418418
The threading model of the D2D factory and the resources it creates.
419419

420-
`writeFactoryType`
420+
*writeFactoryType*
421421
A value that specifies whether the write factory object will be shared or isolated
422422

423423
### Return Value
@@ -633,14 +633,14 @@ CString RegisterWindowClass(LPCTSTR lpszClassNamePrefix);
633633
```
634634

635635
### Parameters
636-
[in] `lpszClassNamePrefix`
636+
[in] *lpszClassNamePrefix*
637637
The name of the window class to register.
638638

639639
### Return Value
640640
The qualified name of the registered class if this method succeeds; otherwise, a [resource exception](http://msdn.microsoft.com/library/ddd99292-819b-4fa4-8371-b1954ed5856d).
641641

642642
### Remarks
643-
The return value is a colon-delimited list of the `lpszClassNamePrefix` parameter string, and the hexadecimal text representations of the handles of the current application instance; the application cursor, which is the arrow cursor whose identifier is IDC_ARROW; and the background brush. For more information about registering MFC window classes, see [AfxRegisterClass](../../mfc/reference/application-information-and-management.md#afxregisterclass).
643+
The return value is a colon-delimited list of the *lpszClassNamePrefix* parameter string, and the hexadecimal text representations of the handles of the current application instance; the application cursor, which is the arrow cursor whose identifier is IDC_ARROW; and the background brush. For more information about registering MFC window classes, see [AfxRegisterClass](../../mfc/reference/application-information-and-management.md#afxregisterclass).
644644

645645
### See Also
646646
[AfxRegisterClass](../../mfc/reference/application-information-and-management.md#afxregisterclass)
@@ -673,17 +673,17 @@ BOOL SetLayeredAttrib(
673673
```
674674

675675
### Parameters
676-
[in] `hwnd`
676+
[in] *hwnd*
677677
Handle to the layered window.
678678

679-
[in] `crKey`
679+
[in] *crKey*
680680
The transparency color key that the [Desktop Window Manager](http://msdn.microsoft.com/library/windows/desktop/aa969540) uses to compose the layered window.
681681

682-
[in] `bAlpha`
682+
[in] *bAlpha*
683683
The alpha value that is used to describe the opacity of the layered window.
684684

685-
[in] `dwFlags`
686-
A bitwise combination (OR) of flags that specify which method parameters to use. Specify LWA_COLORKEY to use the `crKey` parameter as the transparency color. Specify LWA_ALPHA to use the `bAlpha` parameter to determine the opacity of the layered window.
685+
[in] *dwFlags*
686+
A bitwise combination (OR) of flags that specify which method parameters to use. Specify LWA_COLORKEY to use the *crKey* parameter as the transparency color. Specify LWA_ALPHA to use the *bAlpha* parameter to determine the opacity of the layered window.
687687

688688
### Return Value
689689
`TRUE` if this method succeeds; otherwise, `FALSE`.
@@ -703,10 +703,10 @@ BOOL SetMenuFont(
703703
```
704704

705705
### Parameters
706-
[in] `lpLogFont`
706+
[in] *lpLogFont*
707707
Pointer to a structure that contains the attributes of a font.
708708

709-
[in] `bHorz`
709+
[in] *bHorz*
710710
`TRUE` to specify that the text runs horizontally; `FALSE` to specify that the text runs vertically.
711711

712712
### Return Value
@@ -812,17 +812,17 @@ HRESULT ShellCreateItemFromParsingName(
812812
```
813813

814814
### Parameters
815-
`pszPath`
815+
*pszPath*
816816
[in] A pointer to a display name.
817817

818-
`pbc`
818+
*pbc*
819819
A pointer to a bind context that controls the parsing operation.
820820

821-
`riid`
821+
*riid*
822822
A reference to an interface ID.
823823

824-
`ppv`
825-
[out] When this function returns, contains the interface pointer requested in `riid`. This will typically be `IShellItem` or `IShellItem2`.
824+
*ppv*
825+
[out] When this function returns, contains the interface pointer requested in *riid*. This will typically be `IShellItem` or `IShellItem2`.
826826

827827
### Return Value
828828
Returns S_OK if successful; an error value otherwise.

‎docs/mfc/reference/afx-messages.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ These messages are used in MFC.
2020

2121
||||||
2222
|-|-|-|-|-|
23-
|Message|Description|[in] `wParam`|`lParam` (All parameters are [in] unless otherwise stated.)|Return Value|
23+
|Message|Description|[in] *wParam*|*lParam* (All parameters are [in] unless otherwise stated.)|Return Value|
2424
|AFX_WM_ACCGETOBJECT|Not used.|Not used.|Not applicable.|Not applicable.|
2525
|AFX_WM_ACCGETSTATE|Used for accessibility support. Send this message to `CMFCPopupMenu` or `CMFCRibbonPanelMenu` to retrieve the state of the current element.|Index of element, which could be a menu button or separator.|Not used.|The element state. It is -1 if the index is invalid, 0 if the menu button has no special attributes. Otherwise it is a combination of the following flags:<br /><br /> TBBS_DISABLED — item is disabled<br /><br /> TBBS_CHECKED — item is checked<br /><br /> TBBS_BUTTON — the item is a standard pushbutton<br /><br /> TBBS_PRESSED — button is pressed<br /><br /> TBBS_INDETERMINATE — undefined state<br /><br /> TBBS_SEPARATOR - rather than a menu button, this element forms a separation between other menu items|
2626
|AFX_WM_CHANGE_ACTIVE_TAB|The framework sends this message to the resizable control bar control. Process this message to receive notifications from `CMFCTabCtrl` objects when a user changes an active tab.|The index of a tab.|Not used.|Nonzero.|
@@ -62,7 +62,7 @@ These messages are used in MFC.
6262
|AFX_WM_UPDATETOOLTIPS|Sent to all tooltip owners to indicate that their tooltip controls should be recreated.|The type of control that should process this message. See the table later in this topic for a list of possible values.|Not used.|Not used.|
6363
|AFX_WM_WINDOW_HELP|`CMFCWindowsManagerDialog` sends this message to the parent frame when the user clicks the **Help** button, or enters the help mode by clicking the **Help** caption button or the F1 key.|Not used.|A pointer to the instance of `CMFCWindowsManagerDialog`.|Not used.|
6464

65-
The following table shows the values for the low word of the `lParam` parameter of the AFX_WM_HSCROLL method:
65+
The following table shows the values for the low word of the *lParam* parameter of the AFX_WM_HSCROLL method:
6666

6767
|||
6868
|-|-|
@@ -78,9 +78,9 @@ These messages are used in MFC.
7878
|SB_THUMBTRACK|The user is dragging the scroll box. The AFX_WM_ON_HSCROLL message is sent repeatedly with this value until the user releases the mouse button. The high-order word indicates the position to which the scroll box has been dragged.|
7979

8080
> [!NOTE]
81-
> The high-order word of the `lParam` parameter specifies the current position of the scroll box if the low-order word is SB_THUMBPOSITION or SB_THUMBTRACK; otherwise, this word is not used.
81+
> The high-order word of the *lParam* parameter specifies the current position of the scroll box if the low-order word is SB_THUMBPOSITION or SB_THUMBTRACK; otherwise, this word is not used.
8282
83-
The following table lists the flag values for the `lParam` parameter of the AFX_WM_UPDATETOOLTIPS message:
83+
The following table lists the flag values for the *lParam* parameter of the AFX_WM_UPDATETOOLTIPS message:
8484

8585
|||
8686
|-|-|

0 commit comments

Comments
 (0)