Skip to content

Commit 43d422f

Browse files
Merge branch 'docs' into patch-2
2 parents fbaf3fb + b2b7c9b commit 43d422f

File tree

22,544 files changed

+260432
-194693
lines changed

Some content is hidden

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

22,544 files changed

+260432
-194693
lines changed

.openpublishing.publish.config.json

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
{
2+
"git_repository_url_open_to_public_contributors": "https://github.com/MicrosoftDocs/sdk-api",
3+
"git_repository_branch_open_to_public_contributors": "docs",
4+
"branches_to_filter": [],
5+
"dependent_repositories": [
6+
{
7+
"path_to_root": "_themes",
8+
"url": "https://github.com/Microsoft/templates.docs.msft",
9+
"branch": "main",
10+
"branch_mapping": {}
11+
},
12+
{
13+
"path_to_root": "_themes.pdf",
14+
"url": "https://github.com/Microsoft/templates.docs.msft.pdf",
15+
"branch": "main",
16+
"branch_mapping": {}
17+
}
18+
],
19+
"branch_target_mapping": {
20+
"live": [
21+
"Publish",
22+
"Pdf"
23+
]
24+
},
25+
"contribution_branch_mappings": {},
26+
"redirection_files": [
27+
".openpublishing.redirection.in-out.json",
28+
".openpublishing.redirection.tilde.json"
29+
],
30+
"docsets_to_publish": [
31+
{
32+
"docset_name": "sdk-api-build",
33+
"build_source_folder": "sdk-api-src/content",
34+
"build_output_subfolder": "sdk-api-build",
35+
"locale": "en-us",
36+
"monikers": [],
37+
"moniker_ranges": [],
38+
"open_to_public_contributors": true,
39+
"xref_query_tags": [
40+
"/dotnet", "/uwp/api", "/windows/winui/api", "/windows/win32/api/", "/windows/windows-app-sdk/api/winrt", "/windows/windows-app-sdk/api/win32"
41+
],
42+
"type_mapping": {
43+
"Conceptual": "Content",
44+
"ManagedReference": "Content",
45+
"RestApi": "Content"
46+
},
47+
"build_entry_point": "docs",
48+
"template_folder": "_themes"
49+
}
50+
],
51+
"notification_subscribers": [],
52+
"sync_notification_subscribers": [],
53+
"skip_source_output_uploading": false,
54+
"need_preview_pull_request": false,
55+
"need_generate_pdf_url_template": true,
56+
"targets": {
57+
"pdf": {
58+
"template_folder": "_themes.pdf"
59+
}
60+
}
61+
}

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: overview
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/_ad/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Active Directory Domain Services
44
ms.assetid: 97ddb8b6-a879-31af-8608-1d0a010a7697
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Active Directory Domain Services

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Active Directory Lightweight Directory Services
44
ms.assetid: a933ffd9-2c89-3567-95fb-78b360ffa035
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Active Directory Lightweight Directory Services
@@ -16,4 +16,4 @@ Overview of the Active Directory Lightweight Directory Services technology.
1616
The Active Directory Lightweight Directory Services technology is not associated with any headers.
1717

1818
For programming guidance for this technology, see:
19-
* [Active Directory Lightweight Directory Services](/previous-versions/windows/desktop/adam)
19+
* [Active Directory Lightweight Directory Services](/previous-versions/windows/desktop/adam)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Active Directory Service Interfaces
44
ms.assetid: 534ca0a3-4d26-3e5d-a913-50ae21601fba
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Active Directory Service Interfaces

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: AllJoyn API
44
ms.assetid: 934044dd-93a8-367b-b7e2-7eb21a01df15
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# AllJoyn API
@@ -19,4 +19,4 @@ To develop AllJoyn API, you need these headers:
1919
* [windows.devices.alljoyn.interop.h](../windows.devices.alljoyn.interop/index.md)
2020

2121
For programming guidance for this technology, see:
22-
* [AllJoyn API](/previous-versions/windows/desktop/alljoyn)
22+
* [AllJoyn API](/previous-versions/windows/desktop/alljoyn)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Antimalware Scan Interface
44
ms.assetid: 2e9afe53-8233-3700-b784-fd4779116249
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Antimalware Scan Interface

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Packaging, deployment, and query of Windows Store apps
44
ms.assetid: 293875dc-2153-3c83-b216-e0140d6681e4
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Packaging, deployment, and query of Windows Store apps

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Audio Devices DDI Reference
44
ms.assetid: 91b97f1d-92f1-3c32-955a-dd6524d5b764
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Audio Devices DDI Reference
@@ -23,4 +23,4 @@ To develop Audio Devices DDI Reference, you need these headers:
2323
* [msapofxproxy.h](../msapofxproxy/index.md)
2424

2525
For programming guidance for this technology, see:
26-
* [Audio Devices DDI Reference](/windows-hardware/drivers/audio/)
26+
* [Audio Devices DDI Reference](/windows-hardware/drivers/audio/)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Automation
44
ms.assetid: fa0e9310-2f3a-3207-9d42-b2f8ad9f6315
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Automation
@@ -22,4 +22,4 @@ To develop Automation, you need these headers:
2222
* [wtypes.h](../wtypes/index.md)
2323

2424

25-
This documentation is related to OLE Automation. For information on UI Automation, see [Windows Automation API overview](/windows/win32/winauto/windows-automation-api-portal).
25+
This documentation is related to OLE Automation. For information on UI Automation, see [Windows Automation API overview](/windows/win32/winauto/windows-automation-api-portal).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Unmanaged C++ Version of the AXE API
44
ms.assetid: 0ebaa899-6918-3bd4-b858-1afff58ee6a4
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Unmanaged C++ Version of the AXE API

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"tech": "backup",
33
"headers": [
4+
"processthreadsapi.h",
45
"winbase.h",
56
"sisbkup.h",
67
"winnt.h"

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Backup
44
ms.assetid: fba69533-b827-3423-a307-5b3ac1132271
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Backup

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
"winternl.h",
1414
"debugapi.h",
1515
"processenv.h",
16-
"processthreadsapi.h",
1716
"memoryapi.h",
1817
"minwinbase.h",
1918
"wct.h",

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: System Services
44
ms.assetid: e0daa3a7-613f-39bd-87ba-ff1ef0bec914
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# System Services
@@ -44,7 +44,6 @@ To develop System Services, you need these headers:
4444
* [powersetting.h](../powersetting/index.md)
4545
* [powrprof.h](../powrprof/index.md)
4646
* [processenv.h](../processenv/index.md)
47-
* [processthreadsapi.h](../processthreadsapi/index.md)
4847
* [processtopologyapi.h](../processtopologyapi/index.md)
4948
* [profileapi.h](../profileapi/index.md)
5049
* [pwm.h](../pwm/index.md)
@@ -87,11 +86,10 @@ For programming guidance for this technology, see:
8786
* [Interprocess Communications](/windows/desktop/ipc)
8887
* [Memory Management](/windows/desktop/memory)
8988
* [Power Management](/windows/desktop/power)
90-
* [Processes and Threads](/windows/desktop/procthread)
9189
* [Services](/windows/desktop/services)
9290
* [System Shutdown](/windows/desktop/shutdown)
9391
* [Synchronization](/windows/desktop/sync)
9492
* [Windows System Information](/windows/desktop/sysinfo)
9593
* [Virtual Disk Service](/windows/desktop/VDS/virtual-disk-service-portal)
9694
* [VDS Reference](/windows/desktop/VDS/virtual-disk-service-portal)
97-
* [Volume Shadow Copy Service](/windows/desktop/vss)
95+
* [Volume Shadow Copy Service](/windows/desktop/vss)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Battery Devices Reference
44
ms.assetid: 7433fa8b-bcff-3cc7-a61e-27c29a2f632b
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Battery Devices Reference
@@ -18,4 +18,4 @@ To develop Battery Devices Reference, you need these headers:
1818
* [batclass.h](../batclass/index.md)
1919

2020
For programming guidance for this technology, see:
21-
* [Battery Devices Reference](/windows-hardware/drivers/battery/)
21+
* [Battery Devices Reference](/windows-hardware/drivers/battery/)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Background Intelligent Transfer Service
44
ms.assetid: ac07ff24-925f-3c58-8665-88c85795fdca
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Background Intelligent Transfer Service

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

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,32 @@
11
---
22
UID: TP:bltooth
3-
title: Bluetooth Devices Reference
3+
title: Bluetooth devices reference
44
ms.assetid: a24d2124-fb4a-3c14-aeb8-83c46e9ed71c
5-
ms.date: 01/11/2019
5+
ms.date: 10/20/2022
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

10-
# Bluetooth Devices Reference
10+
# Bluetooth devices reference
1111

1212
## -description
1313

14-
Overview of the Bluetooth Devices Reference technology.
14+
Overview of the Bluetooth devices reference technology.
1515

16-
To develop Bluetooth Devices Reference, you need these headers:
16+
To develop Bluetooth devices reference, you need these headers:
1717

1818
* [bluetoothleapis.h](../bluetoothleapis/index.md)
1919
* [bthledef.h](../bthledef/index.md)
2020

2121
For programming guidance for this technology, see:
22-
* [Bluetooth Devices Reference](/windows-hardware/drivers/bluetooth/)
22+
* [Bluetooth Devices Reference](/windows-hardware/drivers/bluetooth/)
23+
24+
## GUIDs
25+
26+
The following GUIDs are defined in the `bthledef.h` header file. To enumerate paired Bluetooth LE devices, you can use the [SetupDiXxx](/windows/win32/api/setupapi/) Win32 enumeration APIs to enumerate devices of the **GUID_BLUETOOTHLE_DEVICE_INTERFACE** device interface class.
27+
28+
|GUID name, description|Value|
29+
|-|-|
30+
|**GUID_BLUETOOTHLE_DEVICE_INTERFACE**. Bluetooth LE device interface GUID. |0x781aee18, 0x7733, 0x4ce4, 0xad, 0xd0, 0x91, 0xf4, 0x1c, 0x67, 0xb5, 0x92|
31+
|**GUID_BLUETOOTH_GATT_SERVICE_DEVICE_INTERFACE**. Bluetooth LE Service device interface GUID. |0x6e3bb679, 0x4372, 0x40c8, 0x9e, 0xaa, 0x45, 0x09, 0xdf, 0x26, 0x0c, 0xd8|
32+
|**BTH_LE_ATT_BLUETOOTH_BASE_GUID**. Bluetooth base GUID. |0x00000000, 0x0000, 0x1000, 0x80, 0x00, 0x00, 0x80, 0x5F, 0x9B, 0x34, 0xFB|

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Bluetooth
44
ms.assetid: a6693fcc-8eb2-381e-9b6e-5b8f73bc7d2c
55
ms.date: 01/11/2019
66
ms.keywords:
7-
ms.topic: conceptual
7+
ms.topic: overview
88
---
99

1010
# Bluetooth

0 commit comments

Comments
 (0)