Skip to content

Commit d18caf6

Browse files
authored
Merge pull request #987 from msebolt/format-mfc-reference-pr6
format mfc reference pr6
2 parents 5deefc7 + 65878d6 commit d18caf6

30 files changed

+2938
-2934
lines changed

docs/mfc/reference/cgopherfile-class.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class CGopherFile : public CInternetFile
3333
|[CGopherFile::CGopherFile](#cgopherfile)|Constructs a `CGopherFile` object.|
3434

3535
## Remarks
36-
The gopher service does not allow users to write data to a gopher file because this service functions mainly as a menu-driven interface for finding information. The `CGopherFile` member functions **Write**, `WriteString`, and `Flush` are not implemented for `CGopherFile`. Calling these functions on a `CGopherFile` object, returns a [CNotSupportedException](../../mfc/reference/cnotsupportedexception-class.md).
36+
The gopher service does not allow users to write data to a gopher file because this service functions mainly as a menu-driven interface for finding information. The `CGopherFile` member functions `Write`, `WriteString`, and `Flush` are not implemented for `CGopherFile`. Calling these functions on a `CGopherFile` object, returns a [CNotSupportedException](../../mfc/reference/cnotsupportedexception-class.md).
3737

3838
To learn more about how `CGopherFile` works with the other MFC Internet classes, see the article [Internet Programming with WinInet](../../mfc/win32-internet-extensions-wininet.md).
3939

@@ -70,25 +70,25 @@ CGopherFile(
7070
```
7171

7272
### Parameters
73-
`hFile`
73+
*hFile*
7474
A handle to an `HINTERNET` file.
7575

76-
`refLocator`
76+
*refLocator*
7777
A reference to a [CGopherLocator](../../mfc/reference/cgopherlocator-class.md) object.
7878

79-
`pConnection`
79+
*pConnection*
8080
A pointer to a [CGopherConnection](../../mfc/reference/cgopherconnection-class.md) object.
8181

82-
`hSession`
82+
*hSession*
8383
A handle to the current Internet session.
8484

85-
`pstrLocator`
85+
*pstrLocator*
8686
A pointer to a string used to locate the gopher server. See [Gopher Sessions](cgopherlocator-class.md) for more information about gopher locators.
8787

8888
*dwLocLen*
89-
A DWORD containing the number of bytes in `pstrLocator`.
89+
A DWORD containing the number of bytes in *pstrLocator*.
9090

91-
`dwContext`
91+
*dwContext*
9292
A pointer to the context identifier of the file being opened.
9393

9494
### Remarks

docs/mfc/reference/cgopherfilefind-class.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,14 @@ explicit CGopherFileFind(
8888
```
8989

9090
### Parameters
91-
`pConnection`
91+
*pConnection*
9292
A pointer to a [CGopherConnection](../../mfc/reference/cgopherconnection-class.md) object.
9393

94-
`dwContext`
95-
The context identifier for the operation. See **Remarks** for more information about `dwContext`.
94+
*dwContext*
95+
The context identifier for the operation. See **Remarks** for more information about *dwContext*.
9696

9797
### Remarks
98-
The default value for `dwContext` is sent by MFC to the `CGopherFileFind` object from the [CInternetSession](../../mfc/reference/cinternetsession-class.md) object that created the `CGopherFileFind` object. When you construct a `CGopherFileFind` object, you can override the default to set the context identifier to a value of your choosing. The context identifier is returned to [CInternetSession::OnStatusCallback](../../mfc/reference/cinternetsession-class.md#onstatuscallback) to provide status on the object with which it is identified. See the article [Internet First Steps: WinInet](../../mfc/wininet-basics.md) for more information about the context identifier.
98+
The default value for *dwContext* is sent by MFC to the `CGopherFileFind` object from the [CInternetSession](../../mfc/reference/cinternetsession-class.md) object that created the `CGopherFileFind` object. When you construct a `CGopherFileFind` object, you can override the default to set the context identifier to a value of your choosing. The context identifier is returned to [CInternetSession::OnStatusCallback](../../mfc/reference/cinternetsession-class.md#onstatuscallback) to provide status on the object with which it is identified. See the article [Internet First Steps: WinInet](../../mfc/wininet-basics.md) for more information about the context identifier.
9999

100100
## <a name="findfile"></a> CGopherFileFind::FindFile
101101
Call this member function to find a gopher file.
@@ -113,13 +113,13 @@ virtual BOOL FindFile(
113113
```
114114

115115
### Parameters
116-
`refLocator`
116+
*refLocator*
117117
A reference to a [CGopherLocator](../../mfc/reference/cgopherlocator-class.md) object.
118118

119119
*pstrString*
120120
A pointer to a string containing the file name.
121121

122-
`dwFlags`
122+
*dwFlags*
123123
The flags describing how to handle this session. The valid flags are:
124124

125125
- INTERNET_FLAG_RELOAD Get the data from the remote server even if it is locally cached.
@@ -155,10 +155,10 @@ virtual BOOL GetCreationTime(CTime& refTime) const;
155155
```
156156

157157
### Parameters
158-
`pTimeStamp`
158+
*pTimeStamp*
159159
A pointer to a [FILETIME](http://msdn.microsoft.com/library/windows/desktop/ms724284) structure containing the time the file was created.
160160

161-
`refTime`
161+
*refTime*
162162
A reference to a [CTime](../../atl-mfc-shared/reference/ctime-class.md) object.
163163

164164
### Return Value
@@ -179,10 +179,10 @@ virtual BOOL GetLastAccessTime(FILETIME* pTimeStamp) const;
179179
```
180180

181181
### Parameters
182-
`refTime`
182+
*refTime*
183183
A reference to a [CTime](../../atl-mfc-shared/reference/ctime-class.md) object.
184184

185-
`pTimeStamp`
185+
*pTimeStamp*
186186
A pointer to a [FILETIME](http://msdn.microsoft.com/library/windows/desktop/ms724284) structure containing the time the file was last accessed.
187187

188188
### Return Value
@@ -203,10 +203,10 @@ virtual BOOL GetLastWriteTime(CTime& refTime) const;
203203
```
204204

205205
### Parameters
206-
`pTimeStamp`
206+
*pTimeStamp*
207207
A pointer to a [FILETIME](http://msdn.microsoft.com/library/windows/desktop/ms724284) structure containing the time the file was last written to.
208208

209-
`refTime`
209+
*refTime*
210210
A reference to a [CTime](../../atl-mfc-shared/reference/ctime-class.md) object.
211211

212212
### Return Value

docs/mfc/reference/cgopherlocator-class.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ CGopherLocator(const CGopherLocator& ref);
6969
```
7070

7171
### Parameters
72-
`ref`
72+
*ref*
7373
A reference to a constant `CGopherLocator` object.
7474

7575
### Remarks

docs/mfc/reference/cheaderctrl-class.md

+41-41
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ BOOL ClearFilter(int nColumn);
127127
```
128128

129129
### Parameters
130-
`nColumn`
130+
*nColumn*
131131
Column value indicating which filter to clear.
132132

133133
### Return Value
@@ -151,23 +151,23 @@ virtual BOOL Create(
151151
```
152152

153153
### Parameters
154-
`dwStyle`
154+
*dwStyle*
155155
Specifies the header control's style. For a description of header control styles, see [Header Control Styles](http://msdn.microsoft.com/library/windows/desktop/bb775241) in the Windows SDK.
156156

157-
`rect`
157+
*rect*
158158
Specifies the header control's size and position. It can be either a [CRect](../../atl-mfc-shared/reference/crect-class.md) object or a [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure.
159159

160-
`pParentWnd`
160+
*pParentWnd*
161161
Specifies the header control's parent window, usually a `CDialog`. It must not be **NULL**.
162162

163-
`nID`
163+
*nID*
164164
Specifies the header control's ID.
165165

166166
### Return Value
167167
Nonzero if initialization was successful; otherwise zero.
168168

169169
### Remarks
170-
You construct a `CHeaderCtrl` object in two steps. First, call the constructor and then call **Create**, which creates the header control and attaches it to the `CHeaderCtrl` object.
170+
You construct a `CHeaderCtrl` object in two steps. First, call the constructor and then call `Create`, which creates the header control and attaches it to the `CHeaderCtrl` object.
171171

172172
In addition to the header control styles, you can use the following common control styles to determine how the header control positions and resizes itself (see [Common Control Styles](http://msdn.microsoft.com/library/windows/desktop/bb775498) for more information):
173173

@@ -195,7 +195,7 @@ virtual BOOL Create(
195195

196196
- **WS_TABSTOP** Specifies one of any number of controls through which the user can move by using the TAB key. The TAB key moves the user to the next control specified by the **WS_TABSTOP** style.
197197

198-
If you want to use extended windows styles with your control, call [CreateEx](#createex) instead of **Create**.
198+
If you want to use extended windows styles with your control, call [CreateEx](#createex) instead of `Create`.
199199

200200
### Example
201201
[!code-cpp[NVC_MFC_CHeaderCtrl#4](../../mfc/reference/codesnippet/cpp/cheaderctrl-class_4.cpp)]
@@ -213,26 +213,26 @@ virtual BOOL CreateEx(
213213
```
214214

215215
### Parameters
216-
`dwExStyle`
217-
Specifies the extended style of the control being created. For a list of extended Windows styles, see the `dwExStyle` parameter for [CreateWindowEx](http://msdn.microsoft.com/library/windows/desktop/ms632680) in the Windows SDK.
216+
*dwExStyle*
217+
Specifies the extended style of the control being created. For a list of extended Windows styles, see the *dwExStyle* parameter for [CreateWindowEx](http://msdn.microsoft.com/library/windows/desktop/ms632680) in the Windows SDK.
218218

219-
`dwStyle`
219+
*dwStyle*
220220
The header control's style. For a description of header control styles, see [Header Control Styles](http://msdn.microsoft.com/library/windows/desktop/bb775241) in the Windows SDK. See [Create](#create) for a list of additional styles.
221221

222-
`rect`
223-
A reference to a [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure describing the size and position of the window to be created, in client coordinates of `pParentWnd`.
222+
*rect*
223+
A reference to a [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure describing the size and position of the window to be created, in client coordinates of *pParentWnd*.
224224

225-
`pParentWnd`
225+
*pParentWnd*
226226
A pointer to the window that is the control's parent.
227227

228-
`nID`
228+
*nID*
229229
The control's child-window ID.
230230

231231
### Return Value
232232
Nonzero if successful; otherwise 0.
233233

234234
### Remarks
235-
Use `CreateEx` instead of **Create** to apply extended Windows styles, specified by the Windows extended style preface **WS_EX_**.
235+
Use `CreateEx` instead of `Create` to apply extended Windows styles, specified by the Windows extended style preface **WS_EX_**.
236236

237237
## <a name="createdragimage"></a> CHeaderCtrl::CreateDragImage
238238
Creates a transparent version of an item's image within a header control.
@@ -242,7 +242,7 @@ CImageList* CreateDragImage(int nIndex);
242242
```
243243

244244
### Parameters
245-
`nIndex`
245+
*nIndex*
246246
The zero-based index of the item within the header control. The image assigned to this item is the basis for the transparent image.
247247

248248
### Return Value
@@ -261,7 +261,7 @@ BOOL DeleteItem(int nPos);
261261
```
262262

263263
### Parameters
264-
`nPos`
264+
*nPos*
265265
Specifies the zero-based index of the item to delete.
266266

267267
### Return Value
@@ -278,15 +278,15 @@ virtual void DrawItem(LPDRAWITEMSTRUCT lpDrawItemStruct);
278278
```
279279

280280
### Parameters
281-
`lpDrawItemStruct`
281+
*lpDrawItemStruct*
282282
A pointer to a [DRAWITEMSTRUCT](http://msdn.microsoft.com/library/windows/desktop/bb775802) structure describing the item to be painted.
283283

284284
### Remarks
285285
The **itemAction** member of the `DRAWITEMSTRUCT` structure defines the drawing action that is to be performed.
286286

287287
By default, this member function does nothing. Override this member function to implement drawing for an owner-draw `CHeaderCtrl` object.
288288

289-
The application should restore all graphics device interface (GDI) objects selected for the display context supplied in `lpDrawItemStruct` before this member function terminates.
289+
The application should restore all graphics device interface (GDI) objects selected for the display context supplied in *lpDrawItemStruct* before this member function terminates.
290290

291291
### Example
292292
[!code-cpp[NVC_MFC_CHeaderCtrl#6](../../mfc/reference/codesnippet/cpp/cheaderctrl-class_6.cpp)]
@@ -301,10 +301,10 @@ BOOL EditFilter(
301301
```
302302

303303
### Parameters
304-
`nColumn`
304+
*nColumn*
305305
The column to edit.
306306

307-
`bDiscardChanges`
307+
*bDiscardChanges*
308308
A value that specifies how to handle the user's editing changes if the user is in the process of editing the filter when the [HDM_EDITFILTER](http://msdn.microsoft.com/library/windows/desktop/bb775312) message is sent.
309309

310310
Specify `true` to discard the changes made by the user, or `false` to accept the changes made by the user.
@@ -383,10 +383,10 @@ BOOL GetItem(
383383
```
384384

385385
### Parameters
386-
`nPos`
386+
*nPos*
387387
Specifies the zero-based index of the item to retrieve.
388388

389-
`pHeaderItem`
389+
*pHeaderItem*
390390
Pointer to an [HDITEM](http://msdn.microsoft.com/library/windows/desktop/bb775247) structure that receives the new item. This structure is used with the `InsertItem` and `SetItem` member functions. Any flags set in the **mask** element ensure that values in the corresponding elements are properly filled in upon return. If the **mask** element is set to zero, values in the other structure elements are meaningless.
391391

392392
### Return Value
@@ -421,8 +421,8 @@ BOOL GetItemDropDownRect(
421421

422422
|Parameter|Description|
423423
|---------------|-----------------|
424-
|[in] `iItem`|Zero-based index of a header item whose style is `HDF_SPLITBUTTON`. For more information, see the `fmt` member of the [HDITEM](http://msdn.microsoft.com/library/windows/desktop/bb775247) structure.|
425-
|[out] `lpRect`|Pointer to a [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure to receive the bounding rectangle information.|
424+
|[in] *iItem*|Zero-based index of a header item whose style is `HDF_SPLITBUTTON`. For more information, see the `fmt` member of the [HDITEM](http://msdn.microsoft.com/library/windows/desktop/bb775247) structure.|
425+
|[out] *lpRect*|Pointer to a [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure to receive the bounding rectangle information.|
426426

427427
### Return Value
428428
`true` if this function is successful; otherwise, `false`.
@@ -450,10 +450,10 @@ BOOL GetItemRect(
450450
```
451451

452452
### Parameters
453-
`nIndex`
453+
*nIndex*
454454
The zero-based index of the header control item.
455455

456-
`lpRect`
456+
*lpRect*
457457
A pointer to the address of a [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure that receives the bounding rectangle information.
458458

459459
### Return Value
@@ -472,10 +472,10 @@ BOOL GetOrderArray(
472472
```
473473

474474
### Parameters
475-
`piArray`
475+
*piArray*
476476
A pointer to the address of a buffer that receives the index values of the items in the header control, in the order in which they appear from left to right.
477477

478-
`iCount`
478+
*iCount*
479479
The number of header control items. Must be non-negative.
480480

481481
### Return Value
@@ -498,7 +498,7 @@ BOOL GetOverflowRect(LPRECT lpRect) const;
498498

499499
|Parameter|Description|
500500
|---------------|-----------------|
501-
|[out] `lpRect`|Pointer to a [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure that receives the bounding rectangle information.|
501+
|[out] *lpRect*|Pointer to a [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure that receives the bounding rectangle information.|
502502

503503
### Return Value
504504
`true` if this function is successful; otherwise, `false`.
@@ -529,7 +529,7 @@ int HitTest(LPHDHITTESTINFO* phdhti);
529529

530530
|Parameter|Description|
531531
|---------------|-----------------|
532-
|[in, out] `phdhti`|Pointer to a [HDHITTESTINFO](http://msdn.microsoft.com/library/windows/desktop/bb775245) structure that specifies the point to test and receives the results of the test.|
532+
|[in, out] *phdhti*|Pointer to a [HDHITTESTINFO](http://msdn.microsoft.com/library/windows/desktop/bb775245) structure that specifies the point to test and receives the results of the test.|
533533

534534
### Return Value
535535
The zero-based index of the header item, if any, at the specified position; otherwise, -1.
@@ -557,7 +557,7 @@ int InsertItem(
557557
```
558558

559559
### Parameters
560-
`nPos`
560+
*nPos*
561561
The zero-based index of the item to be inserted. If the value is zero, the item is inserted at the beginning of the header control. If the value is greater than the maximum value, the item is inserted at the end of the header control.
562562

563563
*phdi*
@@ -614,7 +614,7 @@ int SetBitmapMargin(int nWidth);
614614
```
615615

616616
### Parameters
617-
`nWidth`
617+
*nWidth*
618618
Width, specified in pixels, of the margin that surrounds a bitmap within an existing header control.
619619

620620
### Return Value
@@ -657,7 +657,7 @@ BOOL SetFocusedItem(int iItem);
657657

658658
|Parameter|Description|
659659
|---------------|-----------------|
660-
|[in] `iItem`|Zero-based index of a header item.|
660+
|[in] *iItem*|Zero-based index of a header item.|
661661

662662
### Return Value
663663
`true` if this method is successful; otherwise, `false`.
@@ -684,10 +684,10 @@ int SetHotDivider(int nIndex);
684684
```
685685

686686
### Parameters
687-
`pt`
687+
*pt*
688688
The position of the pointer. The header control highlights the appropriate divider based on the pointer's position.
689689

690-
`nIndex`
690+
*nIndex*
691691
The index of the highlighted divider.
692692

693693
### Return Value
@@ -707,7 +707,7 @@ CImageList* SetImageList(CImageList* pImageList);
707707
```
708708

709709
### Parameters
710-
`pImageList`
710+
*pImageList*
711711
A pointer to a `CImageList` object containing the image list to be assigned to the header control.
712712

713713
### Return Value
@@ -729,10 +729,10 @@ BOOL SetItem(
729729
```
730730

731731
### Parameters
732-
`nPos`
732+
*nPos*
733733
The zero-based index of the item to be manipulated.
734734

735-
`pHeaderItem`
735+
*pHeaderItem*
736736
Pointer to an [HDITEM](http://msdn.microsoft.com/library/windows/desktop/bb775247) structure that contains information about the new item.
737737

738738
### Return Value
@@ -751,10 +751,10 @@ BOOL SetOrderArray(
751751
```
752752

753753
### Parameters
754-
`iCount`
754+
*iCount*
755755
The number of header control items.
756756

757-
`piArray`
757+
*piArray*
758758
A pointer to the address of a buffer that receives the index values of the items in the header control, in the order in which they appear from left to right.
759759

760760
### Return Value

0 commit comments

Comments
 (0)