Skip to content

Commit fe15a8b

Browse files
authored
Merge branch 'MicrosoftDocs:docs' into patch-1
2 parents e36f559 + c53c618 commit fe15a8b

File tree

5,226 files changed

+191851
-159647
lines changed

Some content is hidden

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

5,226 files changed

+191851
-159647
lines changed

LICENSE

Lines changed: 395 additions & 0 deletions
Large diffs are not rendered by default.

LICENSE-CODE

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
The MIT License (MIT)
2+
Copyright (c) Microsoft Corporation
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
5+
associated documentation files (the "Software"), to deal in the Software without restriction,
6+
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
7+
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
8+
subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all copies or substantial
11+
portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
14+
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
15+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
16+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
17+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,3 @@
1-
# Introduction
2-
TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
3-
4-
# Getting Started
5-
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
6-
1. Installation process
7-
2. Software dependencies
8-
3. Latest releases
9-
4. API references
10-
11-
# Build and Test
12-
TODO: Describe and show how to build your code and run the tests.
13-
14-
# Contribute
15-
TODO: Explain how other users and developers can contribute to make your code better.
16-
17-
If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/vsts/git/create-a-readme). You can also seek inspiration from the below readme files:
18-
- [ASP.NET Core](https://github.com/aspnet/AspNetCore)
19-
- [Visual Studio Code](https://github.com/Microsoft/vscode)
20-
- [Chakra Core](https://github.com/Microsoft/ChakraCore)
1+
## Microsoft Open Source Code of Conduct
2+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
3+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"tech": "activity_coordinator",
3+
"headers": [
4+
"activitycoordinator.h",
5+
"activitycoordinatortypes.h"
6+
],
7+
"displayName": "Activity Coordinator"
8+
}
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
UID: TP:activity_coordinator
3+
title: Activity Coordinator
4+
ms.assetid: e190851a-3613-419f-88fd-60c149c00a41
5+
ms.date: 04/26/2022
6+
ms.keywords:
7+
ms.topic: conceptual
8+
---
9+
10+
# Activity Coordinator
11+
12+
## -description
13+
14+
The Activity Coordinator API coordinates execution of deferrable tasks on a system.
15+
16+
To develop for Activity Coordinator, you need these headers:
17+
18+
* [activitycoordinator.h](../activitycoordinator/index.md)
19+
* [activitycoordinatortypes.h](../activitycoordinatortypes/index.md)
20+
21+
For programming guidance for this technology, see:
22+
23+
* [Activity Coordinator overview](/windows/win32/activity_coordinator/activity-coordinator-api-overview)
24+
* [Activity Coordinator API and terminology](/windows/win32/activity_coordinator/activity-coordinator-api-and-terminology)
25+
* [Choosing the right Activity Coordinator policy](/windows/win32/activity_coordinator/choosing-the-right-activity-coordinator-policy)
26+
* [Activity Coordinator example project](/windows/win32/activity_coordinator/activity-coordinator-example-project)
27+
28+
For general Win32 programming guidance, see:
29+
30+
* [Error handling](/windows/win32/debug)
31+
* [Debug help library](/windows/win32/debug)
32+
* [Dynamic-link libraries](/windows/win32/dlls)
33+
* [Event logging](/windows/win32/eventlog)
34+
* [Processes and threads](/windows/win32/procthread)

sdk-api-src/content/_delivery_optimization/config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
"headers": [
44
"deliveryoptimization.h"
55
],
6-
"displayName": "Delivery Optimization (DO)"
7-
}
6+
"displayName": "Delivery Optimization"
7+
}
Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
---
22
UID: TP:delivery_optimization
3-
title: Delivery Optimization (DO)
3+
title: Delivery Optimization
44
ms.assetid: b7d48541-7824-3223-b8f5-5b2639663019
55
ms.date: 01/11/2019
66
ms.keywords:
77
ms.topic: conceptual
88
---
99

10-
# Delivery Optimization (DO)
10+
# Delivery Optimization
1111

1212
## -description
1313

14-
Overview of the Delivery Optimization (DO) technology.
14+
Overview of the Delivery Optimization technology.
1515

16-
The Delivery Optimization (DO) technology is not associated with any headers.
16+
To develop Delivery Optimization, you need these headers:
17+
18+
* [deliveryoptimization.h](../deliveryoptimization/index.md)
1719

1820
For programming guidance for this technology, see:
19-
* [Delivery Optimization (DO)](/windows/desktop/delivery_optimization)
21+
* [Delivery Optimization](/windows/win32/delivery_optimization)
2022

sdk-api-src/content/_directmanipulation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ To develop Direct Manipulation, you need these headers:
1818
* [directmanipulation.h](../directmanipulation/index.md)
1919

2020
For programming guidance for this technology, see:
21-
* [Direct Manipulation](/previous-versions/windows/desktop/directmanipulation)
21+
* [Direct Manipulation](/windows/win32/directmanipulation/direct-manipulation-portal)

sdk-api-src/content/_fs/config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"ktmtypes.h",
2828
"lmshare.h",
2929
"lmstats.h",
30+
"nvme.h",
3031
"wow64apiset.h",
3132
"fileapifromapp.h",
3233
"ioringapi.h",

sdk-api-src/content/_fs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ To develop Data Access and Storage, you need these headers:
3131
* [ntioring_x.h](../ntioring_x/index.md)
3232
* [ntmsapi.h](../ntmsapi/index.md)
3333
* [ntmsmli.h](../ntmsmli/index.md)
34+
* [nvme.h](../nvme/index.md)
3435
* [txfw32.h](../txfw32/index.md)
3536
* [winefs.h](../winefs/index.md)
3637
* [wofapi.h](../wofapi/index.md)

sdk-api-src/content/_mf/config.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
{
22
"tech": "mf",
33
"headers": [
4-
"tbd",
54
"camerauicontrol.h",
65
"d3d11.h",
76
"d3d11_1.h",
@@ -25,20 +24,16 @@
2524
"mfcaptureengine.h",
2625
"mfapi.h",
2726
"mftransform.h",
28-
"mfmediaengine.idl",
2927
"mfmediaengine.h",
3028
"mfmp2dlna.h",
3129
"mfreadwrite.h",
32-
"mftransform.idl",
3330
"evr.h",
3431
"dxva2api.h",
3532
"mfplay.h",
3633
"mfsharingengine.h",
37-
"mfobjects.idl",
3834
"evr9.h",
3935
"mfmediacapture.h",
4036
"mfspatialaudio.h",
41-
"mfidl.idl",
4237
"mfcontentdecryptionmodule.h",
4338
"mfvirtualcamera.h",
4439
"mfd3d12.h"

sdk-api-src/content/_wcs/config.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
{
2-
"tech": "wcs",
3-
"headers": [
4-
"icm.h",
5-
"wingdi.h",
6-
"wcsplugin.h"
7-
],
8-
"displayName": "Windows Color System"
1+
{
2+
"tech": "wcs",
3+
"headers": [
4+
"icm.h",
5+
"wingdi.h",
6+
"wcsplugin.h"
7+
],
8+
"displayName": "Windows Color System"
99
}

sdk-api-src/content/_winrt/config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
"windows.foundation.idl",
4242
"windows.graphics.capture.interop.h",
4343
"windows.graphics.directx.direct3d11.interop.h",
44+
"windows.graphics.display.interop.h",
4445
"windows.graphics.effects.interop.h",
4546
"windows.graphics.imaging.interop.h",
4647
"windows.media.core.interop.h",

sdk-api-src/content/_winrt/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
UID: TP:winrt
33
title: Windows Runtime C++ reference
44
ms.assetid: 19ccb9a3-b0f9-3246-95d5-0d1c2650a2d5
5-
ms.date: 01/11/2019
5+
ms.date: 05/17/2022
66
ms.keywords:
77
ms.topic: conceptual
88
---
@@ -50,6 +50,7 @@ To develop C++ apps that interoperate with the associated Windows Runtime APIs,
5050
* [windows.devices.display.core.interop.h](../windows.devices.display.core.interop/index.md)
5151
* [windows.foundation.h](../windows.foundation/index.md)
5252
* [windows.graphics.capture.interop.h](../windows.graphics.capture.interop/index.md)
53+
* [windows.graphics.display.interop.h](../windows.graphics.display.interop/index.md)
5354
* [windows.graphics.effects.interop.h](../windows.graphics.effects.interop/index.md)
5455
* [windows.graphics.imaging.interop.h](../windows.graphics.imaging.interop/index.md)
5556
* [windows.media.core.interop.h](../windows.media.core.interop/index.md)
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
UID: NA:activitycoordinator
3+
tech.root: activity_coordinator
4+
title: activitycoordinator
5+
ms.date: 04/27/2022
6+
targetos: Windows
7+
description: This header is used by Activity Coordinator C++ reference.
8+
prerelease: false
9+
req.assembly:
10+
req.construct-type: apiset
11+
req.ddi-compliance:
12+
req.dll:
13+
req.header: activitycoordinator.h
14+
req.idl:
15+
req.include-header:
16+
req.irql:
17+
req.kmdf-ver:
18+
req.lib:
19+
req.max-support:
20+
req.namespace:
21+
req.redist:
22+
req.target-min-winverclnt:
23+
req.target-min-winversvr:
24+
req.target-type:
25+
req.typenames:
26+
req.type-library:
27+
req.umdf-ver:
28+
req.unicode-ansi:
29+
topic_type:
30+
- apiref
31+
api_type:
32+
- HeaderDef
33+
api_location:
34+
- activitycoordinator.h
35+
api_name:
36+
- activitycoordinator
37+
f1_keywords:
38+
- activitycoordinator
39+
- activitycoordinator/activitycoordinator
40+
dev_langs:
41+
- c++
42+
helpviewer_keywords:
43+
- activitycoordinator
44+
---
45+
46+
## -description
47+
48+
This header is used by the Activity Coordinator C/C++ API. For more information, see:
49+
50+
- [Activity Coordinator](../_activity_coordinator/index.md)
51+
52+
## -remarks
53+
54+
## -see-also
55+
56+
[activitycoordinatortypes.h](../activitycoordinatortypes/index.md)
57+
58+
## -examples
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
UID: NF:activitycoordinator.CreateActivityCoordinatorPolicy
3+
tech.root: activity_coordinator
4+
title: CreateActivityCoordinatorPolicy
5+
ms.date: 04/25/2022
6+
targetos: Windows
7+
description: Allocates a new policy and pre-populates fields based on the supplied policy template enumeration.
8+
prerelease: false
9+
req.assembly:
10+
req.construct-type: function
11+
req.ddi-compliance:
12+
req.dll:
13+
req.header: activitycoordinator.h
14+
req.idl:
15+
req.include-header:
16+
req.irql:
17+
req.kmdf-ver:
18+
req.lib:
19+
req.max-support:
20+
req.namespace:
21+
req.redist:
22+
req.target-min-winverclnt:
23+
req.target-min-winversvr:
24+
req.target-type:
25+
req.type-library:
26+
req.umdf-ver:
27+
req.unicode-ansi:
28+
topic_type:
29+
- apiref
30+
api_type:
31+
-
32+
api_location:
33+
- activitycoordinator.h
34+
api_name:
35+
- CreateActivityCoordinatorPolicy
36+
f1_keywords:
37+
- CreateActivityCoordinatorPolicy
38+
- activitycoordinator/CreateActivityCoordinatorPolicy
39+
dev_langs:
40+
- c++
41+
helpviewer_keywords:
42+
- CreateActivityCoordinatorPolicy
43+
---
44+
45+
## -description
46+
47+
Allocates a new policy and pre-populates fields based on the supplied policy template enumeration. The caller can customize the policy further using [SetActivityCoordinatorPolicyResourceCondition](nf-activitycoordinator-setactivitycoordinatorpolicyresourcecondition.md).
48+
49+
## -parameters
50+
51+
### -param policyTemplate
52+
53+
Supplies a policy template enumeration value.
54+
55+
### -param policy
56+
57+
Supplies a pointer to an **ACTIVITY_COORDINATOR_POLICY** handle that receives the created policy handle.
58+
59+
## -returns
60+
61+
Returns an **HRESULT**.
62+
63+
## -remarks
64+
65+
The caller should subscribe to the policy to receive coordination notifications using [SubscribeActivityCoordinatorPolicy](nf-activitycoordinator-subscribeactivitycoordinatorpolicy.md). When no longer needed, the caller should destroy the policy using [DestroyActivityCoordinatorPolicy](nf-activitycoordinator-destroyactivitycoordinatorpolicy.md).
66+
67+
## -see-also
68+
69+
[GetActivityCoordinatorPolicyResourceCondition](nf-activitycoordinator-getactivitycoordinatorpolicyresourcecondition.md)
70+
71+
[SetActivityCoordinatorPolicyResourceCondition](nf-activitycoordinator-setactivitycoordinatorpolicyresourcecondition.md)
72+
73+
[SubscribeActivityCoordinatorPolicy](nf-activitycoordinator-subscribeactivitycoordinatorpolicy.md)
74+
75+
[DestroyActivityCoordinatorPolicy](nf-activitycoordinator-destroyactivitycoordinatorpolicy.md)
76+
77+
[ACTIVITY_COORDINATOR_POLICY_TEMPLATE](../activitycoordinatortypes/ne-activitycoordinatortypes-activity_coordinator_policy_template.md)

0 commit comments

Comments
 (0)