Skip to content

Commit cd88097

Browse files
authored
Merge pull request #1024 from msebolt/reformat-mfc-reference-pr10
reformat mfc reference pr10
2 parents f273612 + 802b1f8 commit cd88097

30 files changed

+588
-587
lines changed

docs/mfc/reference/colelinkingdoc-class.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ virtual COleClientItem* OnFindEmbeddedItem(LPCTSTR lpszItemName);
102102
Pointer to the name of the embedded OLE item requested.
103103

104104
### Return Value
105-
A pointer to the specified item; **NULL** if the item is not found.
105+
A pointer to the specified item; NULL if the item is not found.
106106

107107
### Remarks
108108
The default implementation searches the list of embedded items for an item with the specified name (the name comparison is case sensitive). Override this function if you have your own method of storing or naming embedded OLE items.
@@ -119,10 +119,10 @@ virtual COleServerItem* OnGetLinkedItem(LPCTSTR lpszItemName);
119119
Pointer to the name of the linked OLE item requested.
120120

121121
### Return Value
122-
A pointer to the specified item; **NULL** if the item is not found.
122+
A pointer to the specified item; NULL if the item is not found.
123123

124124
### Remarks
125-
The default `COleLinkingDoc` implementation always returns **NULL**. This function is overriden in the derived class `COleServerDoc` to search the list of OLE server items for a linked item with the specified name (the name comparison is case sensitive). Override this function if you have implemented your own method of storing or retrieving linked server items.
125+
The default `COleLinkingDoc` implementation always returns NULL. This function is overriden in the derived class `COleServerDoc` to search the list of OLE server items for a linked item with the specified name (the name comparison is case sensitive). Override this function if you have implemented your own method of storing or retrieving linked server items.
126126

127127
## <a name="register"></a> COleLinkingDoc::Register
128128
Informs the OLE system DLLs that the document is open.
@@ -135,7 +135,7 @@ BOOL Register(
135135

136136
### Parameters
137137
*pFactory*
138-
Pointer to an OLE factory object (can be **NULL**).
138+
Pointer to an OLE factory object (can be NULL).
139139

140140
*lpszPathName*
141141
Pointer to the fully qualified path of the container document.

docs/mfc/reference/colelinksdialog-class.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ class COleLinksDialog : public COleDialog
3939

4040
|Name|Description|
4141
|----------|-----------------|
42-
|[COleLinksDialog::m_el](#m_el)|A structure of type **OLEUIEDITLINKS** that controls the behavior of the dialog box.|
42+
|[COleLinksDialog::m_el](#m_el)|A structure of type OLEUIEDITLINKS that controls the behavior of the dialog box.|
4343

4444
## Remarks
45-
Create an object of class `COleLinksDialog` when you want to call this dialog box. After a `COleLinksDialog` object has been constructed, you can use the [m_el](#m_el) structure to initialize the values or states of controls in the dialog box. The `m_el` structure is of type **OLEUIEDITLINKS**. For more information about using this dialog class, see the [DoModal](#domodal) member function.
45+
Create an object of class `COleLinksDialog` when you want to call this dialog box. After a `COleLinksDialog` object has been constructed, you can use the [m_el](#m_el) structure to initialize the values or states of controls in the dialog box. The `m_el` structure is of type OLEUIEDITLINKS. For more information about using this dialog class, see the [DoModal](#domodal) member function.
4646

4747
> [!NOTE]
4848
> Application Wizard-generated container code uses this class.
@@ -79,11 +79,11 @@ virtual INT_PTR DoModal();
7979
### Return Value
8080
Completion status for the dialog box. One of the following values:
8181

82-
- **IDOK** if the dialog box was successfully displayed.
82+
- IDOK if the dialog box was successfully displayed.
8383

84-
- **IDCANCEL** if the user canceled the dialog box.
84+
- IDCANCEL if the user canceled the dialog box.
8585

86-
- **IDABORT** if an error occurred. If **IDABORT** is returned, call the `COleDialog::GetLastError` member function to get more information about the type of error that occurred. For a listing of possible errors, see the [OleUIEditLinks](http://msdn.microsoft.com/library/windows/desktop/ms679703) function in the Windows SDK.
86+
- IDABORT if an error occurred. If IDABORT is returned, call the `COleDialog::GetLastError` member function to get more information about the type of error that occurred. For a listing of possible errors, see the [OleUIEditLinks](http://msdn.microsoft.com/library/windows/desktop/ms679703) function in the Windows SDK.
8787

8888
### Remarks
8989
If you want to initialize the various dialog box controls by setting members of the [m_el](#m_el) structure, you should do it before calling `DoModal`, but after the dialog object is constructed.
@@ -107,16 +107,16 @@ COleLinksDialog (
107107
Points to the current view on *pDoc*.
108108

109109
*dwFlags*
110-
Creation flag, which contains either 0 or **ELF_SHOWHELP** to specify whether the Help button will be displayed when the dialog box is displayed.
110+
Creation flag, which contains either 0 or ELF_SHOWHELP to specify whether the Help button will be displayed when the dialog box is displayed.
111111

112112
*pParentWnd*
113-
Points to the parent or owner window object (of type `CWnd`) to which the dialog object belongs. If it is **NULL**, the parent window of the dialog box is set to the main application window.
113+
Points to the parent or owner window object (of type `CWnd`) to which the dialog object belongs. If it is NULL, the parent window of the dialog box is set to the main application window.
114114

115115
### Remarks
116116
This function constructs only a `COleLinksDialog` object. To display the dialog box, call the [DoModal](#domodal) function.
117117

118118
## <a name="m_el"></a> COleLinksDialog::m_el
119-
Structure of type **OLEUIEDITLINKS** used to control the behavior of the Edit Links dialog box.
119+
Structure of type OLEUIEDITLINKS used to control the behavior of the Edit Links dialog box.
120120

121121
```
122122
OLEUIEDITLINKS m_el;

docs/mfc/reference/colemessagefilter-class.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -179,18 +179,18 @@ void SetBusyReply(SERVERCALL nBusyReply);
179179
*nBusyReply*
180180
A value from the `SERVERCALL` enumeration, which is defined in COMPOBJ.H. It can have any one of the following values:
181181

182-
- **SERVERCALL_ISHANDLED** The application can accept calls but may fail in processing a particular call.
182+
- SERVERCALL_ISHANDLED The application can accept calls but may fail in processing a particular call.
183183

184-
- **SERVERCALL_REJECTED** The application probably will never be able to process a call.
184+
- SERVERCALL_REJECTED The application probably will never be able to process a call.
185185

186-
- **SERVERCALL_RETRYLATER** The application is temporarily in a state in which it cannot process a call.
186+
- SERVERCALL_RETRYLATER The application is temporarily in a state in which it cannot process a call.
187187

188188
### Remarks
189189
The [BeginBusyState](#beginbusystate) and [EndBusyState](#endbusystate) functions control the application's busy state.
190190

191191
When an application has been made busy with a call to `BeginBusyState`, it responds to calls from the OLE system DLLs with a value determined by the last setting of `SetBusyReply`. The calling application uses this busy reply to determine what action to take.
192192

193-
By default, the busy reply is **SERVERCALL_RETRYLATER**. This reply causes the calling application to retry the call as soon as possible.
193+
By default, the busy reply is SERVERCALL_RETRYLATER. This reply causes the calling application to retry the call as soon as possible.
194194

195195
## <a name="setmessagependingdelay"></a> COleMessageFilter::SetMessagePendingDelay
196196
Determines how long the calling application waits for a response from the called application before taking further action.

docs/mfc/reference/coleobjectfactory-class.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -103,18 +103,18 @@ COleObjectFactory(
103103
Pointer to the run-time class of the C++ objects this factory can create.
104104

105105
*bMultiInstance*
106-
Indicates whether a single instance of the application can support multiple instantiations. If **TRUE**, multiple instances of the application are launched for each request to create an object.
106+
Indicates whether a single instance of the application can support multiple instantiations. If TRUE, multiple instances of the application are launched for each request to create an object.
107107

108108
*nFlags*
109109
Contains one or more of the following flags:
110110

111-
- **afxRegDefault** Sets the threading model to ThreadingModel=Apartment.
111+
- `afxRegDefault` Sets the threading model to ThreadingModel=Apartment.
112112

113-
- **afxRegInsertable** Allows the control to appear in the **Insert Object** dialog box for OLE objects.
113+
- `afxRegInsertable` Allows the control to appear in the **Insert Object** dialog box for OLE objects.
114114

115-
- **afxRegApartmentThreading** Sets the threading model in the registry to ThreadingModel=Apartment.
115+
- `afxRegApartmentThreading` Sets the threading model in the registry to ThreadingModel=Apartment.
116116

117-
- **afxRegFreeThreading** Sets the threading model in the registry to ThreadingModel=Free.
117+
- `afxRegFreeThreading` Sets the threading model in the registry to ThreadingModel=Free.
118118

119119
You can combine the two flags `afxRegApartmentThreading` and `afxRegFreeThreading` to set ThreadingModel=Both. See [InprocServer32](http://msdn.microsoft.com/library/windows/desktop/ms682390) in the Windows SDK for more information on threading model registration.
120120

@@ -140,7 +140,7 @@ REFCLSID GetClassID() const;
140140
For more information, see [CLSID Key](http://msdn.microsoft.com/library/windows/desktop/ms691424) in the Windows SDK.
141141

142142
## <a name="getlicensekey"></a> COleObjectFactory::GetLicenseKey
143-
Requests a unique license key from the control's DLL and stores it in the `BSTR` pointed to by *pbstrKey*.
143+
Requests a unique license key from the control's DLL and stores it in the BSTR pointed to by *pbstrKey*.
144144

145145
```
146146
virtual BOOL GetLicenseKey(
@@ -153,13 +153,13 @@ virtual BOOL GetLicenseKey(
153153
Reserved for future use.
154154

155155
*pbstrKey*
156-
Pointer to a `BSTR` that will store the license key.
156+
Pointer to a BSTR that will store the license key.
157157

158158
### Return Value
159-
Nonzero if the license-key string is not **NULL**; otherwise 0.
159+
Nonzero if the license-key string is not NULL; otherwise 0.
160160

161161
### Remarks
162-
The default implementation of this function returns 0 and stores nothing in the `BSTR`. If you use MFC ActiveX ControlWizard to create your project, ControlWizard supplies an override that retrieves the control's license key.
162+
The default implementation of this function returns 0 and stores nothing in the BSTR. If you use MFC ActiveX ControlWizard to create your project, ControlWizard supplies an override that retrieves the control's license key.
163163

164164
## <a name="islicensevalid"></a> COleObjectFactory::IsLicenseValid
165165
Determines if the license of the control is valid.
@@ -270,7 +270,7 @@ virtual BOOL UpdateRegistry(BOOL bRegister);
270270

271271
- **UpdateRegistry(** `lpszProgID` **)** Registers this object factory with the OLE system registry. This function is usually called by [CWinApp::InitInstance](../../mfc/reference/cwinapp-class.md#initinstance) when the application is launched.
272272

273-
- **UpdateRegistry(** `bRegister` **)** This form of the function is overridable. If *bRegister* is **TRUE**, this function registers the control class with the system registry. Otherwise, it unregisters the class.
273+
- **UpdateRegistry(** `bRegister` **)** This form of the function is overridable. If *bRegister* is TRUE, this function registers the control class with the system registry. Otherwise, it unregisters the class.
274274

275275
If you use MFC ActiveX ControlWizard to create your project, ControlWizard supplies an override to this pure virtual function.
276276

@@ -300,7 +300,7 @@ virtual BOOL VerifyLicenseKey(BSTR bstrKey);
300300

301301
### Parameters
302302
*bstrKey*
303-
A `BSTR` storing the container's version of the license string.
303+
A BSTR storing the container's version of the license string.
304304

305305
### Return Value
306306
Nonzero if the run-time license is valid; otherwise 0.

0 commit comments

Comments
 (0)