Skip to content

Commit b159399

Browse files
authored
Merge pull request MicrosoftDocs#1016 from msebolt/reformat-mfc-reference-pr5
reformat mfc reference pr5
2 parents 0187f64 + 3b441ea commit b159399

30 files changed

+682
-682
lines changed

docs/mfc/reference/classes-and-functions-generated-by-the-mfc-dll-wizard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The code that the MFC DLL Wizard generates depends on the kind of DLL you are cr
1818
|-----------------|------------|-------------|---------------|
1919
|[Extension](../../build/extension-dlls-overview.md)|None|None|`DllMain`|
2020
|[Regular](../../build/regular-dlls-dynamically-linked-to-mfc.md)|None|Application class derived from `CWinApp`|None|
21-
|[Regular](../../build/regular-dlls-dynamically-linked-to-mfc.md)|Automation|Application class derived from `CWinApp`|**DllGetClassObjectDllCanUnloadNowDllRegisterServer**|
21+
|[Regular](../../build/regular-dlls-dynamically-linked-to-mfc.md)|Automation|Application class derived from `CWinApp`|`DllGetClassObjectDllCanUnloadNowDllRegisterServer`|
2222
|[Extension](../../build/extension-dlls-overview.md)|Window Sockets|None|`DllMain`|
2323
|[Regular](../../build/regular-dlls-dynamically-linked-to-mfc.md)|Window Sockets|Application class derived from `CWinApp`|`InitInstance` contains call to `AfxSocketInit`|
2424

docs/mfc/reference/clinkctrl-class.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,13 @@ virtual BOOL Create(DWORD dwStyle,
102102
Specifies the link control's size and position. It can be either a [CRect](../../atl-mfc-shared/reference/crect-class.md) object or a [RECT](../../mfc/reference/rect-structure1.md) structure.
103103

104104
*pParentWnd*
105-
Specifies the link control's parent window. It must not be `NULL`.
105+
Specifies the link control's parent window. It must not be NULL.
106106

107107
*nID*
108108
Specifies the link control's ID.
109109

110110
### Return Value
111-
`true` if initialization was successful; otherwise `false`.
111+
TRUE if initialization was successful; otherwise FALSE.
112112

113113
### Remarks
114114
You construct a `CLinkCtrl` object in two steps. First, call the constructor and then call `Create`, which creates the link control and attaches it to the `CLinkCtrl` object. If you want to use extended windows styles with your control, call [CLinkCtrl::CreateEx](#createex) instead of `Create`.
@@ -159,13 +159,13 @@ virtual BOOL CreateEx(DWORD dwExStyle,
159159
Specifies the link control's size and position. It can be either a [CRect](../../atl-mfc-shared/reference/crect-class.md) object or a [RECT](../../mfc/reference/rect-structure1.md) structure.
160160

161161
*pParentWnd*
162-
Specifies the link control's parent window. It must not be `NULL`.
162+
Specifies the link control's parent window. It must not be NULL.
163163

164164
*nID*
165165
Specifies the link control's ID.
166166

167167
### Return Value
168-
`true` if initialization was successful; otherwise `false`.
168+
TRUE if initialization was successful; otherwise FALSE.
169169

170170
### Remarks
171171
Use `CreateEx` instead of [Create](#create) to apply extended Windows style constants.
@@ -221,7 +221,7 @@ BOOL GetItem(PLITEM pItem) const;
221221
A pointer to a [LITEM](http://msdn.microsoft.com/library/windows/desktop/bb760710) structure to receive item information.
222222

223223
### Return Value
224-
Returns **TRUE** on success, **FALSE** on failure.
224+
Returns TRUE on success, FALSE on failure.
225225

226226
### Remarks
227227
This member function implements the behavior of the Win32 message [LM_GETITEM](http://msdn.microsoft.com/library/windows/desktop/bb760720), as described in the Windows SDK.
@@ -254,10 +254,10 @@ BOOL GetItemID(
254254
The size in characters of the *szID* buffer.
255255

256256
### Return Value
257-
Returns **TRUE** on success, **FALSE** on failure.
257+
Returns TRUE on success, FALSE on failure.
258258

259259
> [!NOTE]
260-
> This function also returns **FALSE** if the buffer of *szID or strID* is smaller than **MAX_LINKID_TEXT**.
260+
> This function also returns FALSE if the buffer of *szID or strID* is smaller than MAX_LINKID_TEXT.
261261
262262
### Remarks
263263
Retrieves the ID of a specific link control item. For more information, see the Win32 message [LM_GETITEM](http://msdn.microsoft.com/library/windows/desktop/bb760720) in the Windows SDK.
@@ -280,10 +280,10 @@ BOOL GetItemState(
280280
The value of the specified state item.
281281

282282
*stateMask*
283-
Combination of flags describing which state item to get. For a list of values, see the description of the **state** member in the [LITEM](http://msdn.microsoft.com/library/windows/desktop/bb760710) structure. Allowable items are identical to those allowed in **state**.
283+
Combination of flags describing which state item to get. For a list of values, see the description of the `state` member in the [LITEM](http://msdn.microsoft.com/library/windows/desktop/bb760710) structure. Allowable items are identical to those allowed in `state`.
284284

285285
### Return Value
286-
Returns **TRUE** on success, **FALSE** on failure.
286+
Returns TRUE on success, FALSE on failure.
287287

288288
### Remarks
289289
Retrieves the value of the specified state item of a specific link control item. For more information, see the Win32 message [LM_GETITEM](http://msdn.microsoft.com/library/windows/desktop/bb760720) in the Windows SDK.
@@ -316,10 +316,10 @@ BOOL GetItemUrl(
316316
The size in characters of the *szURL* buffer.
317317

318318
### Return Value
319-
Returns **TRUE** on success, **FALSE** on failure.
319+
Returns TRUE on success, FALSE on failure.
320320

321321
> [!NOTE]
322-
> This function also returns **FALSE** if the buffer of *szUrl or strUrl* is smaller than **MAX_LINKID_TEXT**.
322+
> This function also returns FALSE if the buffer of *szUrl or strUrl* is smaller than MAX_LINKID_TEXT.
323323
324324
### Remarks
325325
Retrieves the URL represented by the specified link control item. For more information, see the Win32 message [LM_GETITEM](http://msdn.microsoft.com/library/windows/desktop/bb760720) in the Windows SDK.
@@ -333,10 +333,10 @@ BOOL HitTest(PLHITTESTINFO phti) const;
333333

334334
### Parameters
335335
*phti*
336-
Pointer to a **LHITTESTINFO** structure containing any information about the link the user clicked.
336+
Pointer to a `LHITTESTINFO` structure containing any information about the link the user clicked.
337337

338338
### Return Value
339-
Returns **TRUE** on success, **FALSE** on failure.
339+
Returns TRUE on success, FALSE on failure.
340340

341341
### Remarks
342342
This member function implements the behavior of the Win32 message [LM_HITTEST](http://msdn.microsoft.com/library/windows/desktop/bb760722), as described in the Windows SDK.
@@ -353,7 +353,7 @@ BOOL SetItem(PLITEM pItem);
353353
A pointer to a [LITEM](http://msdn.microsoft.com/library/windows/desktop/bb760710) structure containing the information to set.
354354

355355
### Return Value
356-
Returns **TRUE** on success, **FALSE** on failure.
356+
Returns TRUE on success, FALSE on failure.
357357

358358
### Remarks
359359
This member function implements the behavior of the Win32 message [LM_SETITEM](http://msdn.microsoft.com/library/windows/desktop/bb760724), as described in the Windows SDK.
@@ -375,7 +375,7 @@ BOOL SetItemID(
375375
A null-terminated string containing the ID of the specified item.
376376

377377
### Return Value
378-
Returns **TRUE** on success, **FALSE** on failure.
378+
Returns TRUE on success, FALSE on failure.
379379

380380
### Remarks
381381
Sets the ID of a specific link control item. For more information, see the Win32 message [LM_SETITEM](http://msdn.microsoft.com/library/windows/desktop/bb760724) in the Windows SDK.
@@ -398,10 +398,10 @@ BOOL SetItemState(
398398
The value of the specified state item being set.
399399

400400
*stateMask*
401-
Combination of flags describing the state item being set. For a list of values, see the description of the **state** member in the [LITEM](http://msdn.microsoft.com/library/windows/desktop/bb760710) structure. Allowable items are identical to those allowed in **state**.
401+
Combination of flags describing the state item being set. For a list of values, see the description of the `state` member in the [LITEM](http://msdn.microsoft.com/library/windows/desktop/bb760710) structure. Allowable items are identical to those allowed in `state`.
402402

403403
### Return Value
404-
Returns **TRUE** on success, **FALSE** on failure.
404+
Returns TRUE on success, FALSE on failure.
405405

406406
### Remarks
407407
Sets the value of the specified state item of a specific link control item. For more information, see the Win32 message [LM_SETITEM](http://msdn.microsoft.com/library/windows/desktop/bb760724) in the Windows SDK.
@@ -423,7 +423,7 @@ BOOL SetItemUrl(
423423
A null-terminated string containing the URL represented by the specified item
424424

425425
### Return Value
426-
Returns **TRUE** on success, **FALSE** on failure.
426+
Returns TRUE on success, FALSE on failure.
427427

428428
### Remarks
429429
Sets the URL represented by the specified link control item. For more information, see the Win32 message [LM_SETITEM](http://msdn.microsoft.com/library/windows/desktop/bb760724) in the Windows SDK.

0 commit comments

Comments
 (0)