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/coletemplateserver-class.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -77,13 +77,13 @@ void ConnectTemplate(
77
77
```
78
78
79
79
### Parameters
80
-
`clsid`
80
+
*clsid*
81
81
Reference to the OLE class ID that the template requests.
82
82
83
-
`pDocTemplate`
83
+
*pDocTemplate*
84
84
Pointer to the document template.
85
85
86
-
`bMultiInstance`
86
+
*bMultiInstance*
87
87
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.
88
88
89
89
### Remarks
@@ -114,7 +114,7 @@ void UpdateRegistry(
114
114
```
115
115
116
116
### Parameters
117
-
`nAppType`
117
+
*nAppType*
118
118
A value from the **OLE_APPTYPE** enumeration, which is defined in AFXDISP.H. It can have any one of the following values:
119
119
120
120
-`OAT_INPLACE_SERVER` Server has full server user-interface.
@@ -125,25 +125,25 @@ void UpdateRegistry(
125
125
126
126
-`OAT_DISPATCH_OBJECT` Object is `IDispatch`-capable.
127
127
128
-
-**OAT_DOC_OBJECT_SERVER** Server supports both embedding and the Document Object component model.
128
+
-`OAT_DOC_OBJECT_SERVER` Server supports both embedding and the Document Object component model.
129
129
130
-
`rglpszRegister`
130
+
*rglpszRegister*
131
131
A list of entries that is written into the registry only if no entries exist.
132
132
133
-
`rglpszOverwrite`
133
+
*rglpszOverwrite*
134
134
A list of entries that is written into the registry regardless of whether any preceding entries exist.
135
135
136
-
`bRegister`
137
-
Determines whether the class is to be registered. If `bRegister` is **TRUE**, the class is registered with the system registry. Otherwise, it unregisters the class.
136
+
*bRegister*
137
+
Determines whether the class is to be registered. If *bRegister* is **TRUE**, the class is registered with the system registry. Otherwise, it unregisters the class.
138
138
139
139
### Remarks
140
140
The registration information is loaded by means of a call to [CDocTemplate::GetDocString](../../mfc/reference/cdoctemplate-class.md#getdocstring). The substrings retrieved are those identified by the indexes **regFileTypeId**, **regFileTypeName**, and **fileNewName**, as described in the `GetDocString` reference pages.
141
141
142
142
If the **regFileTypeId** substring is empty or if the call to `GetDocString` fails for any other reason, this function fails and the file information is not entered in the registry.
143
143
144
-
The information in the arguments `rglpszRegister` and `rglpszOverwrite` is written to the registry through a call to [AfxOleRegisterServerClass](application-control.md#afxoleregisterserverclass). The default information, which is registered when the two arguments are **NULL**, is suitable for most applications. For information on the structure of the information in these arguments, see `AfxOleRegisterServerClass`.
144
+
The information in the arguments *rglpszRegister* and *rglpszOverwrite* is written to the registry through a call to [AfxOleRegisterServerClass](application-control.md#afxoleregisterserverclass). The default information, which is registered when the two arguments are **NULL**, is suitable for most applications. For information on the structure of the information in these arguments, see `AfxOleRegisterServerClass`.
145
145
146
-
For more information, see [Implementing the IDispatch Interface](http://msdn.microsoft.com/en-us/0e171f7f-0022-4e9b-ac8e-98192828e945).
146
+
For more information, see [Implementing the IDispatch Interface](http://msdn.microsoft.com/0e171f7f-0022-4e9b-ac8e-98192828e945).
Copy file name to clipboardExpand all lines: docs/mfc/reference/coleupdatedialog-class.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ explicit COleUpdateDialog(
70
70
```
71
71
72
72
### Parameters
73
-
`pDoc`
73
+
*pDoc*
74
74
Points to the document containing the links that may need updating.
75
75
76
76
*bUpdateLinks*
@@ -79,7 +79,7 @@ explicit COleUpdateDialog(
79
79
*bUpdateEmbeddings*
80
80
Flag that determines whether embedded objects are to be updated.
81
81
82
-
`pParentWnd`
82
+
*pParentWnd*
83
83
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 will be set to the main application window.
Copy file name to clipboardExpand all lines: docs/mfc/reference/collection-class-helpers.md
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
13
13
ms.workload: ["cplusplus"]
14
14
---
15
15
# Collection Class Helpers
16
-
The collection classes `CMap`, `CList`, and `CArray` use templated global helper functions for such purposes as comparing, copying, and serializing elements. As part of your implementation of classes based on `CMap`, `CList`, and `CArray`, you must override these functions as necessary with versions tailored to the type of data stored in your map, list, or array. For information on overriding helper functions such as `SerializeElements`, see the article [Collections: How to Make a Type-Safe Collection](../../mfc/how-to-make-a-type-safe-collection.md). Note that **ConstructElements** and **DestructElements** have been deprecated.
16
+
The collection classes `CMap`, `CList`, and `CArray` use templated global helper functions for such purposes as comparing, copying, and serializing elements. As part of your implementation of classes based on `CMap`, `CList`, and `CArray`, you must override these functions as necessary with versions tailored to the type of data stored in your map, list, or array. For information on overriding helper functions such as `SerializeElements`, see the article [Collections: How to Make a Type-Safe Collection](../../mfc/how-to-make-a-type-safe-collection.md). Note that `ConstructElements` and `DestructElements` have been deprecated.
17
17
18
18
The Microsoft Foundation Class Library provides the following global functions in afxtempl.h to help you customize your collection classes:
19
19
@@ -42,24 +42,24 @@ CompareElements(
42
42
*TYPE*
43
43
The type of the first element to be compared.
44
44
45
-
`pElement1`
45
+
*pElement1*
46
46
Pointer to the first element to be compared.
47
47
48
-
`ARG_TYPE`
48
+
*ARG_TYPE*
49
49
The type of the second element to be compared.
50
50
51
-
`pElement2`
51
+
*pElement2*
52
52
Pointer to the second element to be compared.
53
53
54
54
### Return Value
55
-
Nonzero if the object pointed to by `pElement1` is equal to the object pointed to by `pElement2`; otherwise 0.
55
+
Nonzero if the object pointed to by *pElement1* is equal to the object pointed to by *pElement2*; otherwise 0.
56
56
57
57
### Remarks
58
58
The `CMap` calls use the `CMap` template parameters *KEY* and `ARG_KEY`.
59
59
60
60
The default implementation returns the result of the comparison of *\*pElement1* and *\*pElement2*. Override this function so that it compares the elements in a way that is appropriate for your application.
61
61
62
-
The C++ language defines the comparison operator ( `==`) for simple types ( `char`, `int`, **float**, and so on) but does not define a comparison operator for classes and structures. If you want to use `CompareElements` or to instantiate one of the collection classes that uses it, you must either define the comparison operator or overload `CompareElements` with a version that returns appropriate values.
62
+
The C++ language defines the comparison operator ( `==`) for simple types ( **char**, **int**, **float**, and so on) but does not define a comparison operator for classes and structures. If you want to use `CompareElements` or to instantiate one of the collection classes that uses it, you must either define the comparison operator or overload `CompareElements` with a version that returns appropriate values.
63
63
64
64
### Requirements
65
65
**Header:** afxtempl.h
@@ -79,13 +79,13 @@ void AFXAPI CopyElements(
79
79
*TYPE*
80
80
Template parameter specifying the type of elements to be copied.
81
81
82
-
`pDest`
82
+
*pDest*
83
83
Pointer to the destination where the elements will be copied.
84
84
85
-
`pSrc`
85
+
*pSrc*
86
86
Pointer to the source of the elements to be copied.
87
87
88
-
`nCount`
88
+
*nCount*
89
89
Number of elements to be copied.
90
90
91
91
### Remarks
@@ -108,20 +108,20 @@ void AFXAPI DumpElements(
108
108
```
109
109
110
110
### Parameters
111
-
`dc`
111
+
*dc*
112
112
Dump context for dumping elements.
113
113
114
114
*TYPE*
115
115
Template parameter specifying the type of the elements.
116
116
117
-
`pElements`
117
+
*pElements*
118
118
Pointer to the elements to be dumped.
119
119
120
-
`nCount`
120
+
*nCount*
121
121
Number of elements to be dumped.
122
122
123
123
### Remarks
124
-
The **CArray::Dump**, **CList::Dump**, and **CMap::Dump** functions call this if the depth of the dump is greater than 0.
124
+
The `CArray::Dump`, `CList::Dump`, and `CMap::Dump` functions call this if the depth of the dump is greater than 0.
125
125
126
126
The default implementation does nothing. If the elements of your collection are derived from `CObject`, your override will typically iterate through the collection's elements, calling `Dump` for each element in turn.
This function is called directly by [CMap::RemoveKey](cmap-class.md#removekey) and indirectly by [CMap::Lookup](cmap-class.md#lookup) and [CMap::Operator []](cmap-class.md#operator_at).
152
152
153
-
The default implementation creates a hash value by shifting `key` right by four positions. Override this function so that it returns hash values appropriate for your application.
153
+
The default implementation creates a hash value by shifting *key* right by four positions. Override this function so that it returns hash values appropriate for your application.
Copy file name to clipboardExpand all lines: docs/mfc/reference/coloradjustment-structure.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
13
13
ms.workload: ["cplusplus"]
14
14
---
15
15
# COLORADJUSTMENT Structure
16
-
The `COLORADJUSTMENT` structure defines the color adjustment values used by the Windows `StretchBlt` and **StretchDIBits** functions when the `StretchBlt` mode is **HALFTONE**.
16
+
The `COLORADJUSTMENT` structure defines the color adjustment values used by the Windows `StretchBlt` and `StretchDIBits` functions when the `StretchBlt` mode is **HALFTONE**.
Application-supplied data for the second item being compared. This value was passed in the call that added the item to the combo or list box.
53
53
54
54
## Remarks
55
-
Whenever an application adds a new item to an owner-drawn list box or combo box created with the **CBS_SORT** or **LBS_SORT** style, Windows sends the owner a `WM_COMPAREITEM` message. The `lParam` parameter of the message contains a long pointer to a `COMPAREITEMSTRUCT` structure. Upon receiving the message, the owner compares the two items and returns a value indicating which item sorts before the other.
55
+
Whenever an application adds a new item to an owner-drawn list box or combo box created with the **CBS_SORT** or **LBS_SORT** style, Windows sends the owner a WM_COMPAREITEM message. The *lParam* parameter of the message contains a long pointer to a `COMPAREITEMSTRUCT` structure. Upon receiving the message, the owner compares the two items and returns a value indicating which item sorts before the other.
Specifies the name of the control class whose connection point this is.
53
53
54
54
*localClass*
55
55
Specifies the name of the local class that implements the connection point.
56
56
57
57
### Remarks
58
-
In the declaration (.h) file that defines the member functions for your class, start the connection point with the `BEGIN_CONNECTION_PART` macro, then add the `CONNECTION_IID` macro and any other member functions you wish to implement, and complete the connection point map with the `END_CONNECTION_PART` macro.
58
+
In the declaration (.h) file that defines the member functions for your class, start the connection point with the BEGIN_CONNECTION_PART macro, then add the CONNECTION_IID macro and any other member functions you wish to implement, and complete the connection point map with the END_CONNECTION_PART macro.
Use between the `BEGIN_CONNECTION_PART` and `END_CONNECTION_PART` macros to define an interface ID for a connection point supported by your OLE control.
78
+
Use between the BEGIN_CONNECTION_PART and END_CONNECTION_PART macros to define an interface ID for a connection point supported by your OLE control.
79
79
80
80
```
81
81
CONNECTION_IID(iid)
82
82
```
83
83
84
84
### Parameters
85
-
`iid`
85
+
*iid*
86
86
The interface ID of the interface called by the connection point.
87
87
88
88
### Remarks
89
-
The `iid` argument is an interface ID used to identify the interface that the connection point will call on its connected sinks. For example:
89
+
The *iid* argument is an interface ID used to identify the interface that the connection point will call on its connected sinks. For example:
If your control supports additional points, use the `DECLARE_CONNECTION_MAP` macro at the end of your class declaration. Then, in the .cpp file that defines the member functions for the class, use the `BEGIN_CONNECTION_MAP` macro, `CONNECTION_PART` macros for each of the control's connection points, and the `END_CONNECTION_MAP` macro to declare the end of the connection map.
106
+
If your control supports additional points, use the DECLARE_CONNECTION_MAP macro at the end of your class declaration. Then, in the .cpp file that defines the member functions for the class, use the BEGIN_CONNECTION_MAP macro, CONNECTION_PART macros for each of the control's connection points, and the END_CONNECTION_MAP macro to declare the end of the connection map.
Specifies the name of the control class whose connection map this is.
121
121
122
122
*theBase*
123
-
Specifies the name of the base class of `theClass`.
123
+
Specifies the name of the base class of *theClass*.
124
124
125
125
### Remarks
126
-
In the implementation (.CPP) file that defines the member functions for your class, start the connection map with the `BEGIN_CONNECTION_MAP` macro, then add macro entries for each of your connection points using the [CONNECTION_PART](#connection_part) macro. Finally, complete the connection map with the [END_CONNECTION_MAP](#end_connection_map) macro.
126
+
In the implementation (.CPP) file that defines the member functions for your class, start the connection map with the BEGIN_CONNECTION_MAP macro, then add macro entries for each of your connection points using the [CONNECTION_PART](#connection_part) macro. Finally, complete the connection map with the [END_CONNECTION_MAP](#end_connection_map) macro.
A pointer to the object that implements the interface.
186
186
187
-
`iid`
187
+
*iid*
188
188
The interface ID of the connection.
189
189
190
-
`bRefCount`
191
-
**TRUE** indicates that creating the connection should cause the reference count of `pUnkSink` to be incremented. **FALSE** indicates that the reference count should not be incremented.
190
+
*bRefCount*
191
+
**TRUE** indicates that creating the connection should cause the reference count of *pUnkSink* to be incremented. **FALSE** indicates that the reference count should not be incremented.
192
192
193
-
`pdwCookie`
194
-
A pointer to a `DWORD` where a connection identifier is returned. This value should be passed as the `dwCookie` parameter to `AfxConnectionUnadvise` when disconnecting the connection.
193
+
*pdwCookie*
194
+
A pointer to a `DWORD` where a connection identifier is returned. This value should be passed as the *dwCookie* parameter to `AfxConnectionUnadvise` when disconnecting the connection.
195
195
196
196
### Return Value
197
197
Nonzero if a connection was established; otherwise 0.
A pointer to the object that implements the interface.
223
223
224
-
`iid`
224
+
*iid*
225
225
The interface ID of the connection point interface.
226
226
227
-
`bRefCount`
228
-
**TRUE** indicates that disconnecting the connection should cause the reference count of `pUnkSink` to be decremented. **FALSE** indicates that the reference count should not be decremented.
227
+
*bRefCount*
228
+
**TRUE** indicates that disconnecting the connection should cause the reference count of *pUnkSink* to be decremented. **FALSE** indicates that the reference count should not be decremented.
229
229
230
-
`dwCookie`
230
+
*dwCookie*
231
231
The connection identifier returned by `AfxConnectionAdvise`.
0 commit comments