Skip to content

Commit 049829c

Browse files
author
Colin Robertson
committed
Additional table updates
1 parent 88a7b11 commit 049829c

File tree

192 files changed

+1581
-888
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

192 files changed

+1581
-888
lines changed

docs/atl-mfc-shared/reference/coledatetimespan-class.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class COleDateTimeSpan
4242

4343
### Public Operators
4444

45-
|||
45+
|Name|Description|
4646
|-|-|
4747
|[operator +, -](#operator_add_-)|Add, subtract, and change sign for `COleDateTimeSpan` values.|
4848
|[operator +=, -=](#operator_add_eq_-_eq)|Add and subtract a `COleDateTimeSpan` value from this `COleDateTimeSpan` value.|

docs/atl-mfc-shared/reference/cstringdata-class.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ struct CStringData
1919

2020
### Methods
2121

22-
|||
22+
|Name|Description|
2323
|-|-|
2424
|[AddRef](#addref)|Increments the reference count of the string data object.|
2525
|[data](#data)|Retrieves the character data of a string object.|
@@ -31,7 +31,7 @@ struct CStringData
3131

3232
### Data Members
3333

34-
|||
34+
|Name|Description|
3535
|-|-|
3636
|[nAllocLength](#nalloclength)|Length of allocated data in `XCHAR`s (not including terminating null)|
3737
|[nDataLength](#ndatalength)|Length of currently used data in `XCHAR`s (not including terminating null)|

docs/atl-mfc-shared/reference/cstringt-class.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Determines if the string class needs C Run-Time (CRT) Library support and where
9898

9999
### Operators
100100

101-
|||
101+
|Name|Description|
102102
|-|-|
103103
|[CStringT::operator =](#operator_eq)|Assigns a new value to a `CStringT` object.|
104104
|[CStringT::operator +](#operator_add)|Concatenates two strings or a character and a string.|

docs/atl-mfc-shared/reference/ctime-class.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ class CTime
4646

4747
### Operators
4848

49-
|||
49+
|Name|Description|
5050
|-|-|
5151
|[operator + -](#operator_add_-)|These operators add and subtract `CTimeSpan` and `CTime` objects.|
5252
|[operator +=, -=](#operator_add_eq_-_eq)|These operators add and subtract a `CTimeSpan` object to and from this `CTime` object.|

docs/atl-mfc-shared/reference/ctimespan-class.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class CTimeSpan
4040

4141
### Operators
4242

43-
|||
43+
|Name|Description|
4444
|-|-|
4545
|[operator + -](#operator_add_-)|Adds and subtracts `CTimeSpan` objects.|
4646
|[operator += -=](#operator_add_eq_-_eq)|Adds and subtracts a `CTimeSpan` object to and from this `CTimeSpan`.|

docs/atl-mfc-shared/reference/iatlstringmgr-class.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ __interface IAtlStringMgr
1919

2020
### Methods
2121

22-
|||
22+
|Name|Description|
2323
|-|-|
2424
|[Allocate](#allocate)|Call this method to allocate a new string data structure.|
2525
|[Clone](#clone)|Call this method to return a pointer to a new string manager for use with another instance of `CSimpleStringT`.|

docs/atl/reference/atl-http-utility-functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.assetid: 4db57ef2-31fa-4696-bbeb-79a9035033ed
77

88
These functions support manipulation of URLs.
99

10-
|||
10+
|Function|Description|
1111
|-|-|
1212
|[AtlCanonicalizeUrl](#atlcanonicalizeurl)|Canonicalizes a URL, which includes converting unsafe characters and spaces into escape sequences.|
1313
|[AtlCombineUrl](#atlcombineurl)|Combines a base URL and a relative URL into a single, canonical URL.|

docs/atl/reference/atl-path-functions.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ ATL provides the ATLPath class for manipulating paths in the form of [CPathT](cp
1111

1212
## Related Classes
1313

14-
|||
14+
|Class|Description|
1515
|-|-|
1616
|[CPathT Class](cpatht-class.md)|This class represents a path.|
1717

1818
## Related Typedefs
1919

20-
|||
20+
|Typedef|Description|
2121
|-|-|
2222
|`CPath`|A specialization of [CPathT](cpatht-class.md) using `CString`.|
2323
|`CPathA`|A specialization of [CPathT](cpatht-class.md) using `CStringA`.|
2424
|`CPathW`|A specialization of [CPathT](cpatht-class.md) using `CStringW`.|
2525

2626
## Functions
2727

28-
|||
28+
|Function|Description|
2929
|-|-|
3030
|[ATLPath::AddBackslash](#addbackslash)|This function is an overloaded wrapper for [PathAddBackslash](/windows/win32/api/shlwapi/nf-shlwapi-pathaddbackslashw).|
3131
|[ATLPath::AddExtension](#addextension)|This function is an overloaded wrapper for [PathAddExtension](/windows/win32/api/shlwapi/nf-shlwapi-pathaddextensionw).|

docs/atl/reference/atl-property-page-wizard.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ Specify the names for the object, interface, and classes to be added to your pro
3232

3333
Provides information for the C++ class created to implement the object.
3434

35-
|||
36-
|-|-|
3735
|Term|Definition|
36+
|-|-|
3837
|**Short name**|Sets the abbreviated name for the object. The name that you provide determines the class and **Coclass** names, the file (**.cpp** and **.h**) names, the **Type** name, and the **ProgID**, unless you change those fields individually.|
3938
|**.h file**|Sets the name of the header file for the new object's class. By default, this name is based on the name that you provide in **Short name**. Click the ellipsis button to save the file name to the location of your choice, or to append the class declaration to an existing file. If you select an existing file, the wizard will not save it to the selected location until you click **Finish** in the wizard.<br /><br /> The wizard does not overwrite a file. If you select the name of an existing file, when you click **Finish**, the wizard prompts you to indicate whether the class declaration should be appended to the contents of the file. Click **Yes** to append the file; click **No** to return to the wizard and specify another file name.|
4039
|**Class**|Sets the name of the class that implements the object. This name is based on the name that you provide in **Short name**, preceded by 'C', the typical prefix for a class name.|

docs/atl/reference/atl-text-encoding-functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.assetid: 2ae1648b-2b87-4112-92aa-0069fcfd23da
88

99
These functions support text encoding and decoding.
1010

11-
|||
11+
|Function|Description|
1212
|-|-|
1313
|[AtlGetHexValue](#atlgethexvalue)|Call this function to get the numeric value of a hexadecimal digit.|
1414
|[AtlGetVersion](#atlgetversion)|Call this function to get the version of the ATL library that you are using. |

docs/atl/reference/atl-typedefs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 7dd05baa-3efb-4e3b-af23-793c610f4560
99

1010
The Active Template Library includes the following typedefs.
1111

12-
|||
12+
|Typedef|Description|
1313
|-|-|
1414
|[_ATL_BASE_MODULE](#_atl_base_module)|Defined as a typedef based on [_ATL_BASE_MODULE70](../../atl/reference/atl-base-module70-structure.md).|
1515
|[_ATL_COM_MODULE](#_atl_com_module)|Defined as a typedef based on [_ATL_COM_MODULE70](../../atl/reference/atl-com-module70-structure.md).|

docs/atl/reference/category-macros.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.assetid: 223578cb-6180-4787-a8d8-ba3787a5d3ee
88

99
These macros define category maps.
1010

11-
|||
11+
|Macro|Description|
1212
|-|-|
1313
|[BEGIN_CATEGORY_MAP](#begin_category_map)|Marks the beginning of the category map.|
1414
|[END_CATEGORY_MAP](#end_category_map)|Marks the end of the category map.|

docs/atl/reference/catlarray-class.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The code used to copy or move elements.
2828
2929
### Methods
3030
31-
|||
31+
|Function|Description|
3232
|-|-|
3333
|[Add](#add)|Call this method to add an element to the array object.|
3434
|[Append](#append)|Call this method to add the contents of one array to the end of another.|
@@ -51,13 +51,13 @@ The code used to copy or move elements.
5151
5252
### Operators
5353
54-
|||
54+
|Operator|Description|
5555
|-|-|
5656
|[operator &#91;&#93;](#operator_at)|Call this operator to return a reference to an element in the array.|
5757
5858
### Typedefs
5959
60-
|||
60+
|Typedef|Description|
6161
|-|-|
6262
|[INARGTYPE](#inargtype)|The data type to use for adding elements to the array.|
6363
|[OUTARGTYPE](#outargtype)|The data type to use for retrieving elements from the array.|

docs/atl/reference/caxwindow-class.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class CAxWindow : public CWindow
2222

2323
### Methods
2424

25-
|||
25+
|Function|Description|
2626
|-|-|
2727
|[AttachControl](#attachcontrol)|Attaches an existing ActiveX control to the `CAxWindow` object.|
2828
|[CAxWindow](#caxwindow)|Constructs a `CAxWindow` object.|
@@ -36,7 +36,7 @@ class CAxWindow : public CWindow
3636

3737
### Operators
3838

39-
|||
39+
|Operator|Description|
4040
|-|-|
4141
|[operator =](#operator_eq)|Assigns an HWND to an existing `CAxWindow` object.|
4242

docs/atl/reference/ccomautothreadmodule-class.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class CComAutoThreadModule : public CComModule
2828

2929
### Methods
3030

31-
|||
31+
|Function|Description|
3232
|-|-|
3333
|[CreateInstance](#createinstance)|Selects a thread and then creates an object in the associated apartment.|
3434
|[GetDefaultThreads](#getdefaultthreads)|(Static) Dynamically calculates the number of threads for the module based on the number of processors.|
@@ -38,9 +38,7 @@ class CComAutoThreadModule : public CComModule
3838

3939
### Data Members
4040

41-
### Data Members
42-
43-
|||
41+
|Data member|Description|
4442
|-|-|
4543
|[dwThreadID](#dwthreadid)|Contains the identifier of the current thread.|
4644
|[m_Allocator](#m_allocator)|Manages thread selection.|

docs/atl/reference/ccomcompositecontrol-class.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -99,14 +99,14 @@ True if all controls are to be advised; otherwise false.
9999

100100
### Return Value
101101

102-
|||
103-
|-|-|
104-
|S_OK |All controls in the event sink map were connected or disconnected from their event source successfully.|
105-
|E_FAIL |Not all controls in the event sink map could be connected or disconnected from their event source successfully.|
106-
|E_POINTER |This error usually indicates a problem with an entry in the control's event sink map or a problem with a template argument used in an `IDispEventImpl` or `IDispEventSimpleImpl` base class.|
107-
|CONNECT_E_ADVISELIMIT |The connection point has already reached its limit of connections and cannot accept any more.|
108-
|CONNECT_E_CANNOTCONNECT |The sink does not support the interface required by this connection point.|
109-
|CONNECT_E_NOCONNECTION |The cookie value does not represent a valid connection. This error usually indicates a problem with an entry in the control's event sink map or a problem with a template argument used in an `IDispEventImpl` or `IDispEventSimpleImpl` base class.|
102+
| Value | Description |
103+
|--|--|
104+
| `S_OK` | All controls in the event sink map were connected or disconnected from their event source successfully. |
105+
| `E_FAIL` | Not all controls in the event sink map could be connected or disconnected from their event source successfully. |
106+
| `E_POINTER` | This error usually indicates a problem with an entry in the control's event sink map or a problem with a template argument used in an `IDispEventImpl` or `IDispEventSimpleImpl` base class. |
107+
| `CONNECT_E_ADVISELIMIT` | The connection point has already reached its limit of connections and cannot accept any more. |
108+
| `CONNECT_E_CANNOTCONNECT` | The sink does not support the interface required by this connection point. |
109+
| `CONNECT_E_NOCONNECTION` | The cookie value does not represent a valid connection. This error usually indicates a problem with an entry in the control's event sink map or a problem with a template argument used in an `IDispEventImpl` or `IDispEventSimpleImpl` base class. |
110110

111111
### Remarks
112112

docs/atl/reference/ccomobjectrootex-class.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The class whose methods implement the desired threading model. You can explicitl
2525

2626
### Methods
2727

28-
|||
28+
|Function|Description|
2929
|-|-|
3030
|[CComObjectRootEx](#ccomobjectrootex)|Constructor.|
3131
|[InternalAddRef](#internaladdref)|Increments the reference count for a nonaggregated object.|
@@ -35,7 +35,7 @@ The class whose methods implement the desired threading model. You can explicitl
3535

3636
### CComObjectRootBase Methods
3737

38-
|||
38+
|Function|Description|
3939
|-|-|
4040
|[FinalConstruct](#finalconstruct)|Override in your class to perform any initialization required by your object.|
4141
|[FinalRelease](#finalrelease)|Override in your class to perform any cleanup required by your object.|
@@ -45,14 +45,14 @@ The class whose methods implement the desired threading model. You can explicitl
4545

4646
### Static Functions
4747

48-
|||
48+
|Function|Description|
4949
|-|-|
5050
|[InternalQueryInterface](#internalqueryinterface)|Delegates to the `IUnknown` of a nonaggregated object.|
5151
|[ObjectMain](#objectmain)|Called during module initialization and termination for derived classes listed in the object map.|
5252

5353
### Data Members
5454

55-
|||
55+
|Data member|Description|
5656
|-|-|
5757
|[m_dwRef](#m_dwref)|With `m_pOuterUnknown`, part of a union. Used when the object is not aggregated to hold the reference count of `AddRef` and `Release`.|
5858
|[m_pOuterUnknown](#m_pouterunknown)|With `m_dwRef`, part of a union. Used when the object is aggregated to hold a pointer to the outer unknown.|

docs/atl/reference/ccomsafearraybound-class.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class CComSafeArrayBound : public SAFEARRAYBOUND
1919

2020
### Methods
2121

22-
|||
22+
|Function|Description|
2323
|-|-|
2424
|[CComSafeArrayBound](#ccomsafearraybound)|The constructor.|
2525
|[GetCount](#getcount)|Call this method to return the number of elements.|
@@ -30,7 +30,7 @@ class CComSafeArrayBound : public SAFEARRAYBOUND
3030

3131
### Operators
3232

33-
|||
33+
|Operator|Description|
3434
|-|-|
3535
|[operator =](#operator_eq)|Sets the `CComSafeArrayBound` to a new value.|
3636

docs/atl/reference/ccomsafedeletecriticalsection-class.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ class CComSafeDeleteCriticalSection : public CComCriticalSection
3434

3535
### Data Members
3636

37-
|||
37+
|Data member|Description|
3838
|-|-|
3939
|[m_bInitialized](#m_binitialized)|Flags whether the internal `CRITICAL_SECTION` object has been initialized.|
4040

docs/atl/reference/ccomtearoffobject-class.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ ATL implements its tear-off interfaces in two phases — the `CComTearOffObjectB
4242

4343
### CComTearOffObjectBase Methods
4444

45-
|||
45+
|Function|Description|
4646
|-|-|
4747
|[CComTearOffObjectBase](#ccomtearoffobjectbase)|Constructor.|
4848

4949
### CComTearOffObjectBase Data Members
5050

51-
|||
51+
|Data member|Description|
5252
|-|-|
5353
|[m_pOwner](#m_powner)|A pointer to a `CComObject` derived from the owner class.|
5454

docs/atl/reference/ccomvariant-class.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class CComVariant : public tagVARIANT
4141
4242
### Public Operators
4343
44-
|||
44+
|Operator|Description|
4545
|-|-|
4646
|[CComVariant::operator <](#operator_lt)|Indicates whether the `CComVariant` object is less than the specified VARIANT.|
4747
|[CComVariant::operator >](#operator_gt)|Indicates whether the `CComVariant` object is greater than the specified VARIANT.|

docs/atl/reference/cdialogimpl-class.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The base class of your new class. The default base class is [CWindow](../../atl/
3232

3333
### Methods
3434

35-
|||
35+
|Function|Description|
3636
|-|-|
3737
|[Create](#create)|Creates a modeless dialog box.|
3838
|[DestroyWindow](#destroywindow)|Destroys a modeless dialog box.|
@@ -41,15 +41,15 @@ The base class of your new class. The default base class is [CWindow](../../atl/
4141

4242
### CDialogImplBaseT Methods
4343

44-
|||
44+
|Function|Description|
4545
|-|-|
4646
|[GetDialogProc](#getdialogproc)|Returns the current dialog box procedure.|
4747
|[MapDialogRect](#mapdialogrect)|Maps the dialog-box units of the specified rectangle to screen units (pixels).|
4848
|[OnFinalMessage](#onfinalmessage)|Called after receiving the last message, typically WM_NCDESTROY.|
4949

5050
### Static Functions
5151

52-
|||
52+
|Function|Description|
5353
|-|-|
5454
|[DialogProc](#dialogproc)|Processes messages sent to the dialog box.|
5555
|[StartDialogProc](#startdialogproc)|Called when the first message is received to process messages sent to the dialog box.|

docs/atl/reference/com-interface-entry-macros.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 19dcb768-2e1f-4b8d-a618-453a01a4bd00
99

1010
These macros enter an object's interfaces into its COM map so that they can be accessed by `QueryInterface`. The order of entries in the COM map is the order interfaces will be checked for a matching IID during `QueryInterface`.
1111

12-
|||
12+
|Macro|Description|
1313
|-|-|
1414
|[COM_INTERFACE_ENTRY](#com_interface_entry)|Enters interfaces into the COM interface map.|
1515
|[COM_INTERFACE_ENTRY2](#com_interface_entry2)|Use this macro to disambiguate two branches of inheritance.|

docs/atl/reference/com-map-global-functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: b9612d30-eb23-46ef-8093-d56f237d3cf1
99

1010
These functions provide support for COM Map `IUnknown` implementations.
1111

12-
|||
12+
|Function|Description|
1313
|-|-|
1414
|[AtlInternalQueryInterface](#atlinternalqueryinterface)|Delegates to the `IUnknown` of a nonaggregated object.|
1515
|[InlineIsEqualIUnknown](#inlineisequaliunknown)|Generates efficient code for comparing interfaces against `IUnknown`.|

docs/atl/reference/com-map-macros.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 0f33656d-321f-4996-90cc-9a7f21ab73c3
99

1010
These macros define COM interface maps.
1111

12-
|||
12+
|Macro|Description|
1313
|-|-|
1414
|[BEGIN_COM_MAP](#begin_com_map)|Marks the beginning of the COM interface map entries.|
1515
|[END_COM_MAP](#end_com_map)|Marks the end of the COM interface map entries.|

docs/atl/reference/compiler-options-macros.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: a869adc6-b3de-4299-b040-9ae20b45f82c
99

1010
These macros control specific compiler features.
1111

12-
|||
12+
|Macro|Description|
1313
|-|-|
1414
|[_ATL_ALL_WARNINGS](#_atl_all_warnings)|A symbol that enables errors in projects converted from previous versions of ATL.|
1515
|[_ATL_APARTMENT_THREADED](#_atl_apartment_threaded)|Define if one or more of your objects use apartment threading.|

docs/atl/reference/composite-control-global-functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ These functions provide support for creating dialog boxes, and for creating, hos
1212
> [!IMPORTANT]
1313
> The functions listed in the following table cannot be used in applications that execute in the Windows Runtime.
1414
15-
|||
15+
|Function|Description|
1616
|-|-|
1717
|[AtlAxDialogBox](#atlaxdialogbox)|Creates a modal dialog box from a dialog template provided by the user. The resulting dialog box can contain ActiveX controls.|
1818
|[AtlAxCreateDialog](#atlaxcreatedialog)|Creates a modeless dialog box from a dialog template provided by the user. The resulting dialog box can contain ActiveX controls.|

docs/atl/reference/composite-control-macros.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.assetid: 17f2dd5e-07e6-4aa6-b965-7a361c78c45e
99

1010
These macros define event sink maps and entries.
1111

12-
|||
12+
|Macro|Description|
1313
|-|-|
1414
|[BEGIN_SINK_MAP](#begin_sink_map)|Marks the beginning of the event sink map for the composite control.|
1515
|[END_SINK_MAP](#end_sink_map)|Marks the end of the event sink map for the composite control.|

docs/atl/reference/connection-point-global-functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ These functions provide support for connection points and sink maps.
1212
> [!IMPORTANT]
1313
> The functions listed in the following table cannot be used in applications that execute in the Windows Runtime.
1414
15-
|||
15+
|Function|Description|
1616
|-|-|
1717
|[AtlAdvise](#atladvise)|Creates a connection between an object's connection point and a client's sink.|
1818
|[AtlUnadvise](#atlunadvise)|Terminates the connection established through `AtlAdvise`.|

0 commit comments

Comments
 (0)