You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/mfc/reference/cgopherfile-class.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ class CGopherFile : public CInternetFile
33
33
|[CGopherFile::CGopherFile](#cgopherfile)|Constructs a `CGopherFile` object.|
34
34
35
35
## 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).
37
37
38
38
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).
39
39
@@ -70,25 +70,25 @@ CGopherFile(
70
70
```
71
71
72
72
### Parameters
73
-
`hFile`
73
+
*hFile*
74
74
A handle to an `HINTERNET` file.
75
75
76
-
`refLocator`
76
+
*refLocator*
77
77
A reference to a [CGopherLocator](../../mfc/reference/cgopherlocator-class.md) object.
78
78
79
-
`pConnection`
79
+
*pConnection*
80
80
A pointer to a [CGopherConnection](../../mfc/reference/cgopherconnection-class.md) object.
81
81
82
-
`hSession`
82
+
*hSession*
83
83
A handle to the current Internet session.
84
84
85
-
`pstrLocator`
85
+
*pstrLocator*
86
86
A pointer to a string used to locate the gopher server. See [Gopher Sessions](cgopherlocator-class.md) for more information about gopher locators.
87
87
88
88
*dwLocLen*
89
-
A DWORD containing the number of bytes in `pstrLocator`.
89
+
A DWORD containing the number of bytes in *pstrLocator*.
90
90
91
-
`dwContext`
91
+
*dwContext*
92
92
A pointer to the context identifier of the file being opened.
Copy file name to clipboardexpand all lines: docs/mfc/reference/cgopherfilefind-class.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -88,14 +88,14 @@ explicit CGopherFileFind(
88
88
```
89
89
90
90
### Parameters
91
-
`pConnection`
91
+
*pConnection*
92
92
A pointer to a [CGopherConnection](../../mfc/reference/cgopherconnection-class.md) object.
93
93
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*.
96
96
97
97
### 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.
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.
156
156
157
-
`rect`
157
+
*rect*
158
158
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.
159
159
160
-
`pParentWnd`
160
+
*pParentWnd*
161
161
Specifies the header control's parent window, usually a `CDialog`. It must not be **NULL**.
162
162
163
-
`nID`
163
+
*nID*
164
164
Specifies the header control's ID.
165
165
166
166
### Return Value
167
167
Nonzero if initialization was successful; otherwise zero.
168
168
169
169
### 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.
171
171
172
172
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):
173
173
@@ -195,7 +195,7 @@ virtual BOOL Create(
195
195
196
196
-**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.
197
197
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`.
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.
218
218
219
-
`dwStyle`
219
+
*dwStyle*
220
220
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.
221
221
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*.
224
224
225
-
`pParentWnd`
225
+
*pParentWnd*
226
226
A pointer to the window that is the control's parent.
227
227
228
-
`nID`
228
+
*nID*
229
229
The control's child-window ID.
230
230
231
231
### Return Value
232
232
Nonzero if successful; otherwise 0.
233
233
234
234
### 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_**.
A pointer to a [DRAWITEMSTRUCT](http://msdn.microsoft.com/library/windows/desktop/bb775802) structure describing the item to be painted.
283
283
284
284
### Remarks
285
285
The **itemAction** member of the `DRAWITEMSTRUCT` structure defines the drawing action that is to be performed.
286
286
287
287
By default, this member function does nothing. Override this member function to implement drawing for an owner-draw `CHeaderCtrl` object.
288
288
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.
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.
309
309
310
310
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(
383
383
```
384
384
385
385
### Parameters
386
-
`nPos`
386
+
*nPos*
387
387
Specifies the zero-based index of the item to retrieve.
388
388
389
-
`pHeaderItem`
389
+
*pHeaderItem*
390
390
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.
391
391
392
392
### Return Value
@@ -421,8 +421,8 @@ BOOL GetItemDropDownRect(
421
421
422
422
|Parameter|Description|
423
423
|---------------|-----------------|
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.|
426
426
427
427
### Return Value
428
428
`true` if this function is successful; otherwise, `false`.
@@ -450,10 +450,10 @@ BOOL GetItemRect(
450
450
```
451
451
452
452
### Parameters
453
-
`nIndex`
453
+
*nIndex*
454
454
The zero-based index of the header control item.
455
455
456
-
`lpRect`
456
+
*lpRect*
457
457
A pointer to the address of a [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure that receives the bounding rectangle information.
458
458
459
459
### Return Value
@@ -472,10 +472,10 @@ BOOL GetOrderArray(
472
472
```
473
473
474
474
### Parameters
475
-
`piArray`
475
+
*piArray*
476
476
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.
477
477
478
-
`iCount`
478
+
*iCount*
479
479
The number of header control items. Must be non-negative.
|[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.|
502
502
503
503
### Return Value
504
504
`true` if this function is successful; otherwise, `false`.
@@ -529,7 +529,7 @@ int HitTest(LPHDHITTESTINFO* phdhti);
529
529
530
530
|Parameter|Description|
531
531
|---------------|-----------------|
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.|
533
533
534
534
### Return Value
535
535
The zero-based index of the header item, if any, at the specified position; otherwise, -1.
@@ -557,7 +557,7 @@ int InsertItem(
557
557
```
558
558
559
559
### Parameters
560
-
`nPos`
560
+
*nPos*
561
561
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.
562
562
563
563
*phdi*
@@ -614,7 +614,7 @@ int SetBitmapMargin(int nWidth);
614
614
```
615
615
616
616
### Parameters
617
-
`nWidth`
617
+
*nWidth*
618
618
Width, specified in pixels, of the margin that surrounds a bitmap within an existing header control.
A pointer to a `CImageList` object containing the image list to be assigned to the header control.
712
712
713
713
### Return Value
@@ -729,10 +729,10 @@ BOOL SetItem(
729
729
```
730
730
731
731
### Parameters
732
-
`nPos`
732
+
*nPos*
733
733
The zero-based index of the item to be manipulated.
734
734
735
-
`pHeaderItem`
735
+
*pHeaderItem*
736
736
Pointer to an [HDITEM](http://msdn.microsoft.com/library/windows/desktop/bb775247) structure that contains information about the new item.
737
737
738
738
### Return Value
@@ -751,10 +751,10 @@ BOOL SetOrderArray(
751
751
```
752
752
753
753
### Parameters
754
-
`iCount`
754
+
*iCount*
755
755
The number of header control items.
756
756
757
-
`piArray`
757
+
*piArray*
758
758
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.
0 commit comments