Skip to content

Commit b65385d

Browse files
committed
Merge branch 'main' of https://github.com/MicrosoftDocs/cpp-docs-pr into deopt
2 parents f66b67e + 021caf5 commit b65385d

File tree

88 files changed

+995
-1033
lines changed

Some content is hidden

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

88 files changed

+995
-1033
lines changed

.github/ISSUE_TEMPLATE/new-c---2017-stl-library-documentation-topic-.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/new-c---2020-stl-library-documentation-topic-.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/new-c---2023-stl-library-documentation-topic.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/new-c---stl-library-doc-topic-.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/new-c--20-compiler-doc-topic.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/new-c--23-compiler-doc-topic.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/atl/atl-utilities-reference.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
description: "Learn more about: ATL utilities reference"
32
title: "ATL utilities reference"
3+
description: "Learn more about: ATL utilities reference"
44
ms.date: "11/04/2016"
5-
ms.assetid: dd8a2888-34f4-461e-9bf4-834218f9b95b
65
---
76
# ATL utilities reference
87

@@ -47,8 +46,7 @@ ATL provides code for manipulating paths and URLs in the form of [CPathT](../atl
4746
| [AtlIsUnsafeUrlChar](../atl/reference/atl-http-utility-functions.md#atlisunsafeurlchar) | Call this function to find out whether a character is safe for use in a URL. |
4847
| [AtlUnescapeUrl](../atl/reference/atl-http-utility-functions.md#atlunescapeurl) | Call this function to convert escaped characters back to their original values. |
4948
| [SystemTimeToHttpDate](../atl/reference/atl-http-utility-functions.md#systemtimetohttpdate) | Call this function to convert a system time to a string in a format suitable for using in HTTP headers. |
50-
| [ATLPath::AddBackslash](../atl/reference/atl-path-functions.md#addbackslash) | This function is an overloaded wrapper for [PathAddBackslash](/windows/desktop/api/shlwapi/nf-shlwapi-pathaddbackslasha |
51-
| ). |
49+
| [ATLPath::AddBackslash](../atl/reference/atl-path-functions.md#addbackslash) | This function is an overloaded wrapper for [PathAddBackslash](/windows/win32/api/shlwapi/nf-shlwapi-pathaddbackslasha). |
5250
| [ATLPath::AddExtension](../atl/reference/atl-path-functions.md#addextension) | This function is an overloaded wrapper for [PathAddExtension](/windows/win32/api/shlwapi/nf-shlwapi-pathaddextensionw). |
5351
| [ATLPath::Append](../atl/reference/atl-path-functions.md#append) | This function is an overloaded wrapper for [PathAppend](/windows/win32/api/shlwapi/nf-shlwapi-pathappendw). |
5452
| [ATLPath::BuildRoot](../atl/reference/atl-path-functions.md#buildroot) | This function is an overloaded wrapper for [PathBuildRoot](/windows/win32/api/shlwapi/nf-shlwapi-pathbuildrootw). |
@@ -87,5 +85,5 @@ ATL provides code for manipulating paths and URLs in the form of [CPathT](../atl
8785

8886
## See also
8987

90-
[Concepts](../atl/active-template-library-atl-concepts.md)<br/>
88+
[Concepts](../atl/active-template-library-atl-concepts.md)\
9189
[ATL COM desktop components](../atl/atl-com-desktop-components.md)

docs/atl/reference/ccomcoclass-class.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,39 @@
11
---
2-
description: "Learn more about: CComCoClass Class"
32
title: "CComCoClass Class"
3+
description: "Learn more about: CComCoClass Class"
44
ms.date: "11/04/2016"
55
f1_keywords: ["CComCoClass", "ATLCOM/ATL::CComCoClass", "ATLCOM/ATL::CComCoClass::CreateInstance", "ATLCOM/ATL::CComCoClass::Error", "ATLCOM/ATL::CComCoClass::GetObjectCLSID", "ATLCOM/ATL::CComCoClass::GetObjectDescription"]
66
helpviewer_keywords: ["CComCoClass class", "aggregation [C++], aggregation models"]
7-
ms.assetid: 67cfefa4-8df9-47fa-ad58-2d1a1ae25762
87
---
98
# CComCoClass Class
109

1110
This class provides methods for creating instances of a class, and obtaining its properties.
1211

1312
## Syntax
1413

15-
```
14+
```cpp
1615
template <class T, const CLSID* pclsid = &CLSID_NULL>
1716
class CComCoClass
1817
```
1918
2019
#### Parameters
2120
22-
*T*<br/>
21+
*T*\
2322
Your class, derived from `CComCoClass`.
2423
25-
*pclsid*<br/>
24+
*pclsid*\
2625
A pointer to the CLSID of the object.
2726
2827
## Members
2928
3029
### Public Methods
3130
32-
|Name|Description|
33-
|----------|-----------------|
34-
|[CComCoClass::CreateInstance](#createinstance)|(Static) Creates an instance of the class and queries for an interface.|
35-
|[CComCoClass::Error](#error)|(Static) Returns rich error information to the client.|
36-
|[CComCoClass::GetObjectCLSID](#getobjectclsid)|(Static) Returns the object's class identifier.|
37-
|[CComCoClass::GetObjectDescription](#getobjectdescription)|(Static) Override to return the object's description.|
31+
| Name | Description |
32+
| ---------------------------------------------------------- | ----------------------------------------------------------------------- |
33+
| [CComCoClass::CreateInstance](#createinstance) | (Static) Creates an instance of the class and queries for an interface. |
34+
| [CComCoClass::Error](#error) | (Static) Returns rich error information to the client. |
35+
| [CComCoClass::GetObjectCLSID](#getobjectclsid) | (Static) Returns the object's class identifier. |
36+
| [CComCoClass::GetObjectDescription](#getobjectdescription) | (Static) Override to return the object's description. |
3837
3938
## Remarks
4039
@@ -58,23 +57,23 @@ You can override either of these defaults by specifying another macro in your cl
5857
5958
Use these `CreateInstance` functions to create an instance of a COM object and retrieve an interface pointer without using the COM API.
6059
61-
```
62-
template <class Q>
63-
static HRESULT CreateInstance( Q** pp);
60+
```cpp
61+
template <class Q>
62+
static HRESULT CreateInstance(Q** pp);
6463
65-
template <class Q>
64+
template <class Q>
6665
static HRESULT CreateInstance(IUnknown* punkOuter, Q** pp);
6766
```
6867

6968
### Parameters
7069

71-
*Q*<br/>
70+
*Q*\
7271
The COM interface that should be returned via *pp*.
7372

74-
*punkOuter*<br/>
73+
*punkOuter*\
7574
[in] The outer unknown or controlling unknown of the aggregate.
7675

77-
*pp*<br/>
76+
*pp*\
7877
[out] The address of a pointer variable that receives the requested interface pointer if creation succeeds.
7978

8079
### Return Value
@@ -101,7 +100,7 @@ In the following example, `CDocument` is a wizard-generated ATL class derived fr
101100

102101
This static function sets up the `IErrorInfo` interface to provide error information to the client.
103102

104-
```
103+
```cpp
105104
static HRESULT WINAPI Error(
106105
LPCOLESTR lpszDesc,
107106
const IID& iid = GUID_NULL,
@@ -130,7 +129,7 @@ static HRESULT WINAPI Error(
130129
UINT nID,
131130
const IID& iid = GUID_NULL,
132131
HRESULT hRes = 0,
133-
HINSTANCE hInst = _AtlBaseModule.GetResourceInstance ());
132+
HINSTANCE hInst = _AtlBaseModule.GetResourceInstance());
134133

135134
static HRESULT Error(
136135
UINT nID,
@@ -143,25 +142,25 @@ static HRESULT Error(
143142
144143
### Parameters
145144
146-
*lpszDesc*<br/>
145+
*lpszDesc*\
147146
[in] The string describing the error. The Unicode version of `Error` specifies that *lpszDesc* is of type LPCOLESTR; the ANSI version specifies a type of LPCSTR.
148147
149-
*iid*<br/>
148+
*iid*\
150149
[in] The IID of the interface defining the error or GUID_NULL (the default value) if the error is defined by the operating system.
151150
152-
*hRes*<br/>
151+
*hRes*\
153152
[in] The HRESULT you want returned to the caller. The default value is 0. For more details about *hRes*, see Remarks.
154153
155-
*nID*<br/>
154+
*nID*\
156155
[in] The resource identifier where the error description string is stored. This value should lie between 0x0200 and 0xFFFF, inclusively. In debug builds, an **ASSERT** will result if *nID* does not index a valid string. In release builds, the error description string will be set to "Unknown Error."
157156
158-
*dwHelpID*<br/>
157+
*dwHelpID*\
159158
[in] The help context identifier for the error.
160159
161-
*lpszHelpFile*<br/>
160+
*lpszHelpFile*\
162161
[in] The path and name of the help file describing the error.
163162
164-
*hInst*<br/>
163+
*hInst*\
165164
[in] The handle to the resource. By default, this parameter is `_AtlModule::GetResourceInstance`, where `_AtlModule` is the global instance of [CAtlModule](../../atl/reference/catlmodule-class.md).
166165
167166
### Return Value
@@ -178,7 +177,7 @@ If the *hRes* parameter is nonzero, then `Error` returns the value of *hRes*. If
178177
179178
Provides a consistent way of retrieving the object's CLSID.
180179
181-
```
180+
```cpp
182181
static const CLSID& WINAPI GetObjectCLSID();
183182
```
184183

@@ -190,7 +189,7 @@ The object's class identifier.
190189

191190
This static function retrieves the text description for your class object.
192191

193-
```
192+
```cpp
194193
static LPCTSTR WINAPI GetObjectDescription();
195194
```
196195

docs/atl/reference/ccommultithreadmodel-class.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
---
2-
description: "Learn more about: CComMultiThreadModel Class"
32
title: "CComMultiThreadModel Class"
3+
description: "Learn more about: CComMultiThreadModel Class"
44
ms.date: "11/04/2016"
55
f1_keywords: ["CComMultiThreadModel", "ATLBASE/ATL::CComMultiThreadModel", "ATLBASE/ATL::CComMultiThreadModel::AutoCriticalSection", "ATLBASE/ATL::CComMultiThreadModel::CriticalSection", "ATLBASE/ATL::CComMultiThreadModel::ThreadModelNoCS", "ATLBASE/ATL::CComMultiThreadModel::Decrement", "ATLBASE/ATL::CComMultiThreadModel::Increment"]
66
helpviewer_keywords: ["ATL, multithreading", "CComMultiThreadModel class", "threading [ATL]"]
7-
ms.assetid: db8f1662-2f7a-44b3-b341-ffbfb6e422a3
87
---
98
# CComMultiThreadModel Class
109

1110
`CComMultiThreadModel` provides thread-safe methods for incrementing and decrementing the value of a variable.
1211

1312
## Syntax
1413

15-
```
14+
```cpp
1615
class CComMultiThreadModel
1716
```
1817
@@ -35,7 +34,7 @@ class CComMultiThreadModel
3534
3635
## Remarks
3736
38-
Typically, you use `CComMultiThreadModel` through one of two **`typedef`** names, either [CComObjectThreadModel](atl-typedefs.md#ccomobjectthreadmodel or [CComGlobalsThreadModel](atl-typedefs.md#ccomglobalsthreadmodel. The class referenced by each **`typedef`** depends on the threading model used, as shown in the following table:
37+
Typically, you use `CComMultiThreadModel` through one of two **`typedef`** names, either [CComObjectThreadModel](atl-typedefs.md#ccomobjectthreadmodel) or [CComGlobalsThreadModel](atl-typedefs.md#ccomglobalsthreadmodel). The class referenced by each **`typedef`** depends on the threading model used, as shown in the following table:
3938
4039
|typedef|Single threading|Apartment threading|Free threading|
4140
|-------------|----------------------|-------------------------|--------------------|
@@ -54,7 +53,7 @@ S= `CComSingleThreadModel`; M= `CComMultiThreadModel`
5453
5554
When using `CComMultiThreadModel`, the **`typedef`** name `AutoCriticalSection` references class [CComAutoCriticalSection](ccomautocriticalsection-class.md), which provides methods for obtaining and releasing ownership of a critical section object.
5655
57-
```
56+
```cpp
5857
typedef CComAutoCriticalSection AutoCriticalSection;
5958
```
6059

@@ -120,7 +119,7 @@ The following tables show the results of the `InternalAddRef` and `Lock` methods
120119
121120
When using `CComMultiThreadModel`, the **`typedef`** name `CriticalSection` references class [CComCriticalSection](ccomcriticalsection-class.md), which provides methods for obtaining and releasing ownership of a critical section object.
122121
123-
```
122+
```cpp
124123
typedef CComCriticalSection CriticalSection;
125124
```
126125

@@ -144,13 +143,13 @@ See [CComMultiThreadModel::AutoCriticalSection](#autocriticalsection).
144143

145144
This static function calls the Win32 function [InterlockedDecrement](/windows/win32/api/winnt/nf-winnt-interlockeddecrement), which decrements the value of the variable pointed to by *p*.
146145

147-
```
146+
```cpp
148147
static ULONG WINAPI Decrement(LPLONG p) throw ();
149148
```
150149
151150
### Parameters
152151
153-
*p*<br/>
152+
*p*\
154153
[in] Pointer to the variable to be decremented.
155154
156155
### Return Value
@@ -165,13 +164,13 @@ If the result of the decrement is 0, then `Decrement` returns 0. If the result o
165164
166165
This static function calls the Win32 function [InterlockedIncrement](/windows/win32/api/winnt/nf-winnt-interlockedincrement), which increments the value of the variable pointed to by *p*.
167166
168-
```
167+
```cpp
169168
static ULONG WINAPI Increment(LPLONG p) throw ();
170169
```
171170

172171
### Parameters
173172

174-
*p*<br/>
173+
*p*\
175174
[in] Pointer to the variable to be incremented.
176175

177176
### Return Value
@@ -186,7 +185,7 @@ If the result of the increment is 0, then `Increment` returns 0. If the result o
186185

187186
When using `CComMultiThreadModel`, the **`typedef`** name `ThreadModelNoCS` references class [CComMultiThreadModelNoCS](ccommultithreadmodelnocs-class.md).
188187

189-
```
188+
```cpp
190189
typedef CComMultiThreadModelNoCS ThreadModelNoCS;
191190
```
192191

@@ -208,7 +207,7 @@ See [CComMultiThreadModel::AutoCriticalSection](#autocriticalsection).
208207

209208
## See also
210209

211-
[CComSingleThreadModel Class](ccomsinglethreadmodel-class.md)<br/>
212-
[CComAutoCriticalSection Class](ccomautocriticalsection-class.md)<br/>
213-
[CComCriticalSection Class](ccomcriticalsection-class.md)<br/>
210+
[CComSingleThreadModel Class](ccomsinglethreadmodel-class.md)\
211+
[CComAutoCriticalSection Class](ccomautocriticalsection-class.md)\
212+
[CComCriticalSection Class](ccomcriticalsection-class.md)\
214213
[Class Overview](../atl-class-overview.md)

0 commit comments

Comments
 (0)