Skip to content

Commit adb0299

Browse files
GitHubber17GitHubber17
authored
Merge pull request #1425 from DennisLee-DennisLee/v-dele-1338191-Wrappers_HandleTraits_namespace
1338191: Consolidated the 7 structure types in the Microsoft::WRL::Wrappers::HandleTraits namespace.
2 parents f17a3c9 + 5b8a95f commit adb0299

21 files changed

Lines changed: 296 additions & 580 deletions

‎.openpublishing.redirection.json‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6560,6 +6560,16 @@
65606560
"redirect_url": "/cpp/windows/criticalsection-class#trylock",
65616561
"redirect_document_id": false
65626562
},
6563+
{
6564+
"source_path": "docs/windows/criticalsectiontraits-getinvalidvalue-method.md",
6565+
"redirect_url": "/cpp/windows/criticalsectiontraits-structure#getinvalidvalue",
6566+
"redirect_document_id": false
6567+
},
6568+
{
6569+
"source_path": "docs/windows/criticalsectiontraits-unlock-method.md",
6570+
"redirect_url": "/cpp/windows/criticalsectiontraits-structure#unlock",
6571+
"redirect_document_id": false
6572+
},
65636573
{
65646574
"source_path": "docs/windows/deferrableeventargs-getdeferral-method.md",
65656575
"redirect_url": "/cpp/windows/deferrableeventargs-class#getdeferral",
@@ -6710,6 +6720,16 @@
67106720
"redirect_url": "/cpp/windows/ftmbase-class#unmarshalinterface",
67116721
"redirect_document_id": false
67126722
},
6723+
{
6724+
"source_path": "docs/windows/handlenulltraits-close-method.md",
6725+
"redirect_url": "/cpp/windows/handlenulltraits-structure#close",
6726+
"redirect_document_id": false
6727+
},
6728+
{
6729+
"source_path": "docs/windows/handlenulltraits-getinvalidvalue-method.md",
6730+
"redirect_url": "/cpp/windows/handlenulltraits-structure#getinvalidvalue",
6731+
"redirect_document_id": false
6732+
},
67136733
{
67146734
"source_path": "docs/windows/handlet-tilde-handlet-destructor.md",
67156735
"redirect_url": "/cpp/windows/handlet-class#tilde-handlet",
@@ -6760,6 +6780,16 @@
67606780
"redirect_url": "/cpp/windows/handlet-class#operator-assign",
67616781
"redirect_document_id": false
67626782
},
6783+
{
6784+
"source_path": "docs/windows/handletraits-close-method.md",
6785+
"redirect_url": "/cpp/windows/handletraits-structure#close",
6786+
"redirect_document_id": false
6787+
},
6788+
{
6789+
"source_path": "docs/windows/handletraits-getinvalidvalue-method.md",
6790+
"redirect_url": "/cpp/windows/handletraits-structure#getinvalidvalue",
6791+
"redirect_document_id": false
6792+
},
67636793
{
67646794
"source_path": "docs/windows/hstring-hstring-constructor.md",
67656795
"redirect_url": "/cpp/windows/hstring-class#hstring",
@@ -7165,6 +7195,11 @@
71657195
"redirect_url": "/cpp/windows/mutex-class1#operator-assign",
71667196
"redirect_document_id": false
71677197
},
7198+
{
7199+
"source_path": "docs/windows/mutextraits-unlock-method.md",
7200+
"redirect_url": "/cpp/windows/mutextraits-structure#unlock",
7201+
"redirect_document_id": false
7202+
},
71687203
{
71697204
"source_path": "docs/windows/roinitializewrapper-roinitializewrapper-constructor.md",
71707205
"redirect_url": "/cpp/windows/roinitializewrapper-class#roinitializewrapper",
@@ -7265,6 +7300,11 @@
72657300
"redirect_url": "/cpp/windows/semaphore-class#semaphore",
72667301
"redirect_document_id": false
72677302
},
7303+
{
7304+
"source_path": "docs/windows/semaphoretraits-unlock-method.md",
7305+
"redirect_url": "/cpp/windows/semaphoretraits-structure#unlock",
7306+
"redirect_document_id": false
7307+
},
72687308
{
72697309
"source_path": "docs/windows/simpleactivationfactory-activateinstance-method.md",
72707310
"redirect_url": "/cpp/windows/simpleactivationfactory-class#activateinstance",
@@ -7320,6 +7360,26 @@
73207360
"redirect_url": "/cpp/windows/srwlock-class#trylockshared",
73217361
"redirect_document_id": false
73227362
},
7363+
{
7364+
"source_path": "docs/windows/srwlockexclusivetraits-getinvalidvalue-method.md",
7365+
"redirect_url": "/cpp/windows/srwlockexclusivetraits-structure#getinvalidvalue",
7366+
"redirect_document_id": false
7367+
},
7368+
{
7369+
"source_path": "docs/windows/srwlockexclusivetraits-unlock-method.md",
7370+
"redirect_url": "/cpp/windows/srwlockexclusivetraits-structure#unlock",
7371+
"redirect_document_id": false
7372+
},
7373+
{
7374+
"source_path": "docs/windows/srwlocksharedtraits-getinvalidvalue-method.md",
7375+
"redirect_url": "/cpp/windows/srwlocksharedtraits-structure#getinvalidvalue",
7376+
"redirect_document_id": false
7377+
},
7378+
{
7379+
"source_path": "docs/windows/srwlocksharedtraits-unlock-method.md",
7380+
"redirect_url": "/cpp/windows/srwlocksharedtraits-structure#unlock",
7381+
"redirect_document_id": false
7382+
},
73237383
{
73247384
"source_path": "docs/windows/synclockt-tilde-synclockt-destructor.md",
73257385
"redirect_url": "/cpp/windows/synclockt-class#tilde-synclockt",

‎docs/windows/TOC.md‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -443,26 +443,14 @@
443443
##### [SyncLockWithStatusT Class](synclockwithstatust-class.md)
444444
#### [Microsoft::WRL::Wrappers::HandleTraits Namespace](microsoft-wrl-wrappers-handletraits-namespace.md)
445445
##### [CriticalSectionTraits Structure](criticalsectiontraits-structure.md)
446-
###### [CriticalSectionTraits::GetInvalidValue Method](criticalsectiontraits-getinvalidvalue-method.md)
447-
###### [CriticalSectionTraits::Unlock Method](criticalsectiontraits-unlock-method.md)
448446
##### [EventTraits Structure](eventtraits-structure.md)
449447
##### [FileHandleTraits Structure](filehandletraits-structure.md)
450448
##### [HANDLENullTraits Structure](handlenulltraits-structure.md)
451-
###### [HANDLENullTraits::Close Method](handlenulltraits-close-method.md)
452-
###### [HANDLENullTraits::GetInvalidValue Method](handlenulltraits-getinvalidvalue-method.md)
453449
##### [HANDLETraits Structure](handletraits-structure.md)
454-
###### [HANDLETraits::Close Method](handletraits-close-method.md)
455-
###### [HANDLETraits::GetInvalidValue Method](handletraits-getinvalidvalue-method.md)
456450
##### [MutexTraits Structure](mutextraits-structure.md)
457-
###### [MutexTraits::Unlock Method](mutextraits-unlock-method.md)
458451
##### [SemaphoreTraits Structure](semaphoretraits-structure.md)
459-
###### [SemaphoreTraits::Unlock Method](semaphoretraits-unlock-method.md)
460452
##### [SRWLockExclusiveTraits Structure](srwlockexclusivetraits-structure.md)
461-
###### [SRWLockExclusiveTraits::GetInvalidValue Method](srwlockexclusivetraits-getinvalidvalue-method.md)
462-
###### [SRWLockExclusiveTraits::Unlock Method](srwlockexclusivetraits-unlock-method.md)
463453
##### [SRWLockSharedTraits Structure](srwlocksharedtraits-structure.md)
464-
###### [SRWLockSharedTraits::GetInvalidValue Method](srwlocksharedtraits-getinvalidvalue-method.md)
465-
###### [SRWLockSharedTraits::Unlock Method](srwlocksharedtraits-unlock-method.md)
466454
#### [Windows::Foundation Namespace](windows-foundation-namespace.md)
467455
##### [ActivateInstance Function](activateinstance-function.md)
468456
##### [GetActivationFactory Function](getactivationfactory-function.md)

‎docs/windows/criticalsectiontraits-getinvalidvalue-method.md‎

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

‎docs/windows/criticalsectiontraits-structure.md‎

Lines changed: 45 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "CriticalSectionTraits Structure | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "11/04/2016"
4+
ms.date: "09/26/2018"
55
ms.technology: ["cpp-windows"]
66
ms.topic: "reference"
7-
f1_keywords: ["corewrappers/Microsoft::WRL::Wrappers::HandleTraits::CriticalSectionTraits"]
7+
f1_keywords: ["corewrappers/Microsoft::WRL::Wrappers::HandleTraits::CriticalSectionTraits", "corewrappers/Microsoft::WRL::Wrappers::HandleTraits::CriticalSectionTraits::GetInvalidValue", "corewrappers/Microsoft::WRL::Wrappers::HandleTraits::CriticalSectionTraits::Unlock"]
88
dev_langs: ["C++"]
9-
helpviewer_keywords: ["CriticalSectionTraits structure"]
9+
helpviewer_keywords: ["Microsoft::WRL::Wrappers::HandleTraits::CriticalSectionTraits structure", "Microsoft::WRL::Wrappers::HandleTraits::CriticalSectionTraits::GetInvalidValue method", "Microsoft::WRL::Wrappers::HandleTraits::CriticalSectionTraits::Unlock method"]
1010
ms.assetid: c515a1b5-4eb0-40bc-9035-c4d9352c9de7
1111
author: "mikeblome"
1212
ms.author: "mblome"
@@ -26,16 +26,16 @@ struct CriticalSectionTraits;
2626

2727
### Public Typedefs
2828

29-
|Name|Description|
30-
|----------|-----------------|
31-
|`Type`|A **typedef** that defines a pointer to a critical section. `Type` is defined as `typedef CRITICAL_SECTION* Type;`.|
29+
Name | Description
30+
------ | -----------------------------------------------------------------------------------------------------------------
31+
`Type` | A `typedef` that defines a pointer to a critical section. `Type` is defined as `typedef CRITICAL_SECTION* Type;`.
3232

3333
### Public Methods
3434

35-
|Name|Description|
36-
|----------|-----------------|
37-
|[CriticalSectionTraits::GetInvalidValue Method](../windows/criticalsectiontraits-getinvalidvalue-method.md)|Specializes a `CriticalSection` template so that the template is always invalid.|
38-
|[CriticalSectionTraits::Unlock Method](../windows/criticalsectiontraits-unlock-method.md)|Specializes a `CriticalSection` template so that it supports releasing ownership of the specified critical section object.|
35+
Name | Description
36+
---------------------------------------------------------- | -----------------
37+
[CriticalSectionTraits::GetInvalidValue](#getinvalidvalue) | Specializes a `CriticalSection` template so that the template is always invalid.
38+
[CriticalSectionTraits::Unlock](#unlock) | Specializes a `CriticalSection` template so that it supports releasing ownership of the specified critical section object.
3939

4040
## Inheritance Hierarchy
4141

@@ -47,6 +47,39 @@ struct CriticalSectionTraits;
4747

4848
**Namespace:** Microsoft::WRL::Wrappers::HandleTraits
4949

50-
## See Also
50+
## <a name="getinvalidvalue"></a>CriticalSectionTraits::GetInvalidValue
5151

52-
[Microsoft::WRL::Wrappers::HandleTraits Namespace](../windows/microsoft-wrl-wrappers-handletraits-namespace.md)
52+
Specializes a `CriticalSection` template so that the template is always invalid.
53+
54+
```cpp
55+
inline static Type GetInvalidValue();
56+
```
57+
58+
### Return Value
59+
60+
Always returns a pointer to an invalid critical section.
61+
62+
### Remarks
63+
64+
The `Type` modifier is defined as `typedef CRITICAL_SECTION* Type;`.
65+
66+
## <a name="unlock"></a>CriticalSectionTraits::Unlock
67+
68+
Specializes a `CriticalSection` template so that it supports releasing ownership of the specified critical section object.
69+
70+
```cpp
71+
inline static void Unlock(
72+
_In_ Type cs
73+
);
74+
```
75+
76+
### Parameters
77+
78+
*cs*<br/>
79+
A pointer to a critical section object.
80+
81+
### Remarks
82+
83+
The `Type` modifier is defined as `typedef CRITICAL_SECTION* Type;`.
84+
85+
For more information, see **LeaveCriticalSection function** in the **Synchronization Functions** section of the Windows API documentation.

‎docs/windows/criticalsectiontraits-unlock-method.md‎

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

‎docs/windows/handlenulltraits-close-method.md‎

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

‎docs/windows/handlenulltraits-getinvalidvalue-method.md‎

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

0 commit comments

Comments
 (0)