Skip to content

Commit 5423aa3

Browse files
author
mtx48109
committed
format mfc reference pr5
1 parent fa4d84a commit 5423aa3

30 files changed

Lines changed: 1096 additions & 1095 deletions

‎docs/mfc/reference/cdockstate-class.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ void LoadState(LPCTSTR lpszProfileName);
8686
```
8787

8888
### Parameters
89-
`lpszProfileName`
89+
*lpszProfileName*
9090
Points to a null-teminated string that specifies the name of a section in the initialization file or a key in the Windows registry where state information is stored.
9191

9292
### Remarks
@@ -107,7 +107,7 @@ void SaveState(LPCTSTR lpszProfileName);
107107
```
108108

109109
### Parameters
110-
`lpszProfileName`
110+
*lpszProfileName*
111111
Points to a null-teminated string that specifies the name of a section in the initialization file or a key in the Windows registry where state information is stored.
112112

113113
### Remarks

‎docs/mfc/reference/cdocobjectserver-class.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ void ActivateDocObject();
7474
```
7575

7676
### Remarks
77-
`ActivateDocObject` calls `IOleDocumentSite`'s **ActivateMe** method, but does not show the view because it waits for specific instructions on how to set up and display the view, given in the call to [CDocObjectServer::OnActivateView](#onactivateview).
77+
`ActivateDocObject` calls `IOleDocumentSite`'s `ActivateMe` method, but does not show the view because it waits for specific instructions on how to set up and display the view, given in the call to [CDocObjectServer::OnActivateView](#onactivateview).
7878

7979
Together, `ActivateDocObject` and `OnActivateView` activate and display the DocObject view. DocObject activation differs from other kinds of OLE in-place activation. DocObject activation bypasses displaying in-place hatch borders and object adornments (such as sizing handles), ignores object extent functions, and draws scroll bars within the view rectangle as opposed to drawing them outside that rectangle (as in normal in-place activation).
8080

@@ -91,7 +91,7 @@ explicit CDocObjectServer(
9191
*pOwner*
9292
A pointer to the client site document that is the client for the DocObject server.
9393

94-
`pDocSite`
94+
*pDocSite*
9595
A pointer to the `IOleDocumentSite` interface implemented by the container.
9696

9797
### Remarks
@@ -118,7 +118,7 @@ virtual void OnApplyViewState(CArchive& ar);
118118
```
119119

120120
### Parameters
121-
`ar`
121+
*ar*
122122
A `CArchive` object from which to serialize the view state.
123123

124124
### Remarks
@@ -134,7 +134,7 @@ virtual void OnSaveViewState(CArchive& ar);
134134
```
135135

136136
### Parameters
137-
`ar`
137+
*ar*
138138
A `CArchive` object to which the view state is serialized.
139139

140140
### Remarks

‎docs/mfc/reference/cdocobjectserveritem-class.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@ CDocObjectServerItem(COleServerDoc* pServerDoc, BOOL bAutoDelete);
7171
```
7272

7373
### Parameters
74-
`pServerDoc`
74+
*pServerDoc*
7575
A pointer to the document that will contain the new DocObject item.
7676

77-
`bAutoDelete`
77+
*bAutoDelete*
7878
Indicates whether the object can be deleted when a link to it is released. Set the argument to **FALSE** if the `CDocObjectServerItem` object is an integral part of your document's data. Set it to **TRUE** if the object is a secondary structure used to identify a range in your document's data that can be deleted by the framework.
7979

8080
## <a name="getdocument"></a> CDocObjectServerItem::GetDocument

‎docs/mfc/reference/cdoctemplate-class.md‎

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class CDocTemplate : public CCmdTarget
5656
## Remarks
5757
You usually create one or more document templates in the implementation of your application's `InitInstance` function. A document template defines the relationships among three types of classes:
5858

59-
- A document class, which you derive from **CDocument**.
59+
- A document class, which you derive from `CDocument`.
6060

6161
- A view class, which displays data from the document class listed above. You can derive this class from `CView`, `CScrollView`, `CFormView`, or `CEditView`. (You can also use `CEditView` directly.)
6262

@@ -94,7 +94,7 @@ virtual void AddDocument(CDocument* pDoc);
9494
```
9595

9696
### Parameters
97-
`pDoc`
97+
*pDoc*
9898
A pointer to the document to be added.
9999

100100
### Remarks
@@ -112,7 +112,7 @@ CDocTemplate (
112112
```
113113

114114
### Parameters
115-
`nIDResource`
115+
*nIDResource*
116116
Specifies the ID of the resources used with the document type. This may include menu, icon, accelerator table, and string resources.
117117

118118
The string resource consists of up to seven substrings separated by the '\n' character (the '\n' character is needed as a place holder if a substring is not included; however, trailing '\n' characters are not necessary); these substrings describe the document type. For information on the substrings, see [GetDocString](#getdocstring). This string resource is found in the application's resource file. For example:
@@ -129,13 +129,13 @@ CDocTemplate (
129129

130130
Note that the string begins with a '\n' character; this is because the first substring is not used for MDI applications and so is not included. You can edit this string using the string editor; the entire string appears as a single entry in the String Editor, not as seven separate entries.
131131

132-
`pDocClass`
133-
Points to the `CRuntimeClass` object of the document class. This class is a **CDocument**-derived class you define to represent your documents.
132+
*pDocClass*
133+
Points to the `CRuntimeClass` object of the document class. This class is a `CDocument`-derived class you define to represent your documents.
134134

135-
`pFrameClass`
135+
*pFrameClass*
136136
Points to the `CRuntimeClass` object of the frame window class. This class can be a `CFrameWnd`-derived class, or it can be `CFrameWnd` itself if you want default behavior for your main frame window.
137137

138-
`pViewClass`
138+
*pViewClass*
139139
Points to the `CRuntimeClass` object of the view class. This class is a `CView`-derived class you define to display your documents.
140140

141141
### Remarks
@@ -149,7 +149,7 @@ virtual void CloseAllDocuments(BOOL bEndSession);
149149
```
150150

151151
### Parameters
152-
`bEndSession`
152+
*bEndSession*
153153
Not used.
154154

155155
### Remarks
@@ -177,19 +177,19 @@ virtual CFrameWnd* CreateNewFrame(
177177
```
178178

179179
### Parameters
180-
`pDoc`
180+
*pDoc*
181181
The document to which the new frame window should refer. Can be **NULL**.
182182

183-
`pOther`
183+
*pOther*
184184
The frame window on which the new frame window is to be based. Can be **NULL**.
185185

186186
### Return Value
187187
A pointer to the newly created frame window, or **NULL** if an error occurs.
188188

189189
### Remarks
190-
`CreateNewFrame` uses the `CRuntimeClass` objects passed to the constructor to create a new frame window with a view and document attached. If the `pDoc` parameter is **NULL**, the framework outputs a TRACE message.
190+
`CreateNewFrame` uses the `CRuntimeClass` objects passed to the constructor to create a new frame window with a view and document attached. If the *pDoc* parameter is **NULL**, the framework outputs a TRACE message.
191191

192-
The `pOther` parameter is used to implement the Window New command. It provides a frame window on which to model the new frame window. The new frame window is usually created invisible. Call this function to create frame windows outside the standard framework implementation of File New and File Open.
192+
The *pOther* parameter is used to implement the Window New command. It provides a frame window on which to model the new frame window. The new frame window is usually created invisible. Call this function to create frame windows outside the standard framework implementation of File New and File Open.
193193

194194
## <a name="createoleframe"></a> CDocTemplate::CreateOleFrame
195195
Creates an OLE frame window.
@@ -202,20 +202,20 @@ CFrameWnd* CreateOleFrame(
202202
```
203203

204204
### Parameters
205-
`pParentWnd`
205+
*pParentWnd*
206206
A pointer to the frame's parent window.
207207

208-
`pDoc`
208+
*pDoc*
209209
A pointer to the document to which the new OLE frame window should refer.
210210

211-
`bCreateView`
211+
*bCreateView*
212212
Determines whether a view is created along with the frame.
213213

214214
### Return Value
215215
A pointer to a frame window if successful; otherwise **NULL**.
216216

217217
### Remarks
218-
If `bCreateView` is zero, an empty frame is created.
218+
If *bCreateView* is zero, an empty frame is created.
219219

220220
## <a name="getdocstring"></a> CDocTemplate::GetDocString
221221
Retrieves a string associated with the document type.
@@ -227,7 +227,7 @@ virtual BOOL GetDocString(
227227
```
228228

229229
### Parameters
230-
`rString`
230+
*rString*
231231
A reference to a `CString` object that will contain the string when the function returns.
232232

233233
*index*
@@ -271,7 +271,7 @@ virtual POSITION GetFirstDocPosition() const = 0;
271271
[CSingleDocTemplate](../../mfc/reference/csingledoctemplate-class.md) and [CMultiDocTemplate](../../mfc/reference/cmultidoctemplate-class.md) both override this pure virtual function. Any class you derive from `CDocTemplate` must also override this function.
272272

273273
## <a name="getnextdoc"></a> CDocTemplate::GetNextDoc
274-
Retrieves the list element identified by `rPos`, then sets `rPos` to the **POSITION** value of the next entry in the list.
274+
Retrieves the list element identified by *rPos*, then sets *rPos* to the **POSITION** value of the next entry in the list.
275275

276276
```
277277
virtual CDocument* GetNextDoc(POSITION& rPos) const = 0;
@@ -281,11 +281,11 @@ virtual CDocument* GetNextDoc(POSITION& rPos) const = 0;
281281
A pointer to the next document in the list of documents associated with this template.
282282

283283
### Parameters
284-
`rPos`
284+
*rPos*
285285
A reference to a **POSITION** value returned by a previous call to [GetFirstDocPosition](#getfirstdocposition) or `GetNextDoc`.
286286

287287
### Remarks
288-
If the retrieved element is the last in the list, then the new value of `rPos` is set to **NULL**.
288+
If the retrieved element is the last in the list, then the new value of *rPos* is set to **NULL**.
289289

290290
You can use `GetNextDoc` in a forward iteration loop if you establish the initial position with a call to [GetFirstDocPosition](#getfirstdocposition).
291291

@@ -302,17 +302,17 @@ virtual void InitialUpdateFrame(
302302
```
303303

304304
### Parameters
305-
`pFrame`
305+
*pFrame*
306306
The frame window that needs the initial update.
307307

308-
`pDoc`
308+
*pDoc*
309309
The document to which the frame is associated. Can be **NULL**.
310310

311-
`bMakeVisible`
311+
*bMakeVisible*
312312
Indicates whether the frame should become visible and active.
313313

314314
### Remarks
315-
Call **IntitialUpdateFrame** after creating a new frame with `CreateNewFrame`. Calling this function causes the views in that frame window to receive their `OnInitialUpdate` calls. Also, if there was not previously an active view, the primary view of the frame window is made active; the primary view is a view with a child ID of **AFX_IDW_PANE_FIRST**. Finally, the frame window is made visible if `bMakeVisible` is non-zero. If `bMakeVisible` is zero, the current focus and visible state of the frame window will remain unchanged.
315+
Call **IntitialUpdateFrame** after creating a new frame with `CreateNewFrame`. Calling this function causes the views in that frame window to receive their `OnInitialUpdate` calls. Also, if there was not previously an active view, the primary view of the frame window is made active; the primary view is a view with a child ID of **AFX_IDW_PANE_FIRST**. Finally, the frame window is made visible if `bMakeVisible` is non-zero. If *bMakeVisible* is zero, the current focus and visible state of the frame window will remain unchanged.
316316

317317
It is not necessary to call this function when using the framework's implementation of File New and File Open.
318318

@@ -336,11 +336,11 @@ virtual Confidence MatchDocType(
336336
```
337337

338338
### Parameters
339-
`lpszPathName`
339+
*lpszPathName*
340340
Pathname of the file whose type is to be determined.
341341

342-
`rpDocMatch`
343-
Pointer to a document that is assigned the matching document, if the file specified by `lpszPathName` is already open.
342+
*rpDocMatch*
343+
Pointer to a document that is assigned the matching document, if the file specified by *lpszPathName* is already open.
344344

345345
### Return Value
346346
A value from the **Confidence** enumeration, which is defined as follows:
@@ -360,9 +360,9 @@ enum Confidence
360360
### Remarks
361361
Use this function to determine the type of document template to use for opening a file. If your application supports multiple file types, for example, you can use this function to determine which of the available document templates is appropriate for a given file by calling `MatchDocType` for each template in turn, and choosing a template according to the confidence value returned.
362362

363-
If the file specified by `lpszPathName` is already open, this function returns **CDocTemplate::yesAlreadyOpen** and copies the file's **CDocument** object into the object at `rpDocMatch`.
363+
If the file specified by *lpszPathName* is already open, this function returns **CDocTemplate::yesAlreadyOpen** and copies the file's **CDocument** object into the object at *rpDocMatch*.
364364

365-
If the file is not open but the extension in `lpszPathName` matches the extension specified by **CDocTemplate::filterExt**, this function returns **CDocTemplate::yesAttemptNative** and sets `rpDocMatch` to **NULL**. For more information on **CDocTemplate::filterExt**, see [CDocTemplate::GetDocString](#getdocstring).
365+
If the file is not open but the extension in *lpszPathName* matches the extension specified by **CDocTemplate::filterExt**, this function returns **CDocTemplate::yesAttemptNative** and sets *rpDocMatch* to **NULL**. For more information on **CDocTemplate::filterExt**, see [CDocTemplate::GetDocString](#getdocstring).
366366

367367
If neither case is true, the function returns **CDocTemplate::yesAttemptForeign**.
368368

@@ -380,27 +380,27 @@ virtual CDocument* OpenDocumentFile(
380380
```
381381

382382
### Parameters
383-
[in] `lpszPathName`
383+
[in] *lpszPathName*
384384
Pointer to the path of the file that contains the document to be opened.
385385

386-
[in] `bAddToMRU`
386+
[in] *bAddToMRU*
387387
`TRUE` indicates the document is one of the most recent files; `FALSE` indicates the document is not one of the most recent files.
388388

389389
### Return Value
390-
A pointer to the document whose file is named by `lpszPathName`; `NULL` if unsuccessful.
390+
A pointer to the document whose file is named by *lpszPathName*; `NULL` if unsuccessful.
391391

392392
### Remarks
393-
Opens the file whose path is specified by `lpszPathName`. If `lpszPathName` is `NULL`, a new file that contains a document of the type associated with this template is created.
393+
Opens the file whose path is specified by *lpszPathName*. If *lpszPathName* is `NULL`, a new file that contains a document of the type associated with this template is created.
394394

395395
## <a name="removedocument"></a> CDocTemplate::RemoveDocument
396-
Removes the document pointed to by `pDoc` from the list of documents associated with this template.
396+
Removes the document pointed to by *pDoc* from the list of documents associated with this template.
397397

398398
```
399399
virtual void RemoveDocument(CDocument* pDoc);
400400
```
401401

402402
### Parameters
403-
`pDoc`
403+
*pDoc*
404404
Pointer to the document to be removed.
405405

406406
### Remarks
@@ -424,13 +424,13 @@ void SetContainerInfo(UINT nIDOleInPlaceContainer);
424424
```
425425

426426
### Parameters
427-
`nIDOleInPlaceContainer`
427+
*nIDOleInPlaceContainer*
428428
The ID of the resources used when an embedded object is activated.
429429

430430
### Remarks
431431
Call this function to set the resources to be used when an OLE object is in-place activated. These resources may include menus and accelerator tables. This function is usually called in the [CWinApp::InitInstance](../../mfc/reference/cwinapp-class.md#initinstance) function of your application.
432432

433-
The menu associated with `nIDOleInPlaceContainer` contains separators that allow the menu of the activated in-place item to merge with the menu of the container application. For more information about merging server and container menus, see the article [Menus and Resources (OLE)](../../mfc/menus-and-resources-ole.md).
433+
The menu associated with *nIDOleInPlaceContainer* contains separators that allow the menu of the activated in-place item to merge with the menu of the container application. For more information about merging server and container menus, see the article [Menus and Resources (OLE)](../../mfc/menus-and-resources-ole.md).
434434

435435
## <a name="setdefaulttitle"></a> CDocTemplate::SetDefaultTitle
436436
Call this function to load the document's default title and display it in the document's title bar.
@@ -461,7 +461,7 @@ void SetServerInfo(
461461
*nIDOleEmbedding*
462462
The ID of the resources used when an embedded object is opened in a separate window.
463463

464-
`nIDOleInPlaceServer`
464+
*nIDOleInPlaceServer*
465465
The ID of the resources used when an embedded object is activated in-place.
466466

467467
*pOleFrameClass*
@@ -473,7 +473,7 @@ void SetServerInfo(
473473
### Remarks
474474
Call this member function to identify resources that will be used by the server application when the user requests activation of an embedded object. These resources consist of menus and accelerator tables. This function is usually called in the `InitInstance` of your application.
475475

476-
The menu associated with `nIDOleInPlaceServer` contains separators that allow the server menu to merge with the menu of the container. For more information about merging server and container menus, see the article [Menus and Resources (OLE)](../../mfc/menus-and-resources-ole.md).
476+
The menu associated with *nIDOleInPlaceServer* contains separators that allow the server menu to merge with the menu of the container. For more information about merging server and container menus, see the article [Menus and Resources (OLE)](../../mfc/menus-and-resources-ole.md).
477477

478478
## <a name="createpreviewframe"></a> CDocTemplate::CreatePreviewFrame
479479
Creates a child frame used for Rich Preview.
@@ -485,10 +485,10 @@ CFrameWnd* CreatePreviewFrame(
485485
```
486486

487487
### Parameters
488-
`pParentWnd`
488+
*pParentWnd*
489489
A pointer to a parent window (usually provided by the Shell).
490490

491-
`pDoc`
491+
*pDoc*
492492
A pointer to a document object, whose content will be previewed.
493493

494494
### Return Value
@@ -507,13 +507,13 @@ void SetPreviewInfo(
507507
```
508508

509509
### Parameters
510-
`nIDPreviewFrame`
510+
*nIDPreviewFrame*
511511
Specifies a resource ID of the preview frame.
512512

513-
`pPreviewFrameClass`
513+
*pPreviewFrameClass*
514514
Specifies a pointer to a runtime class information structure of the preview frame.
515515

516-
`pPreviewViewClass`
516+
*pPreviewViewClass*
517517
Specifies a pointer to a runtime class information structure of the preview view.
518518

519519
### Remarks

0 commit comments

Comments
 (0)