Skip to content

Commit f59ebc9

Browse files
Steven WhiteSteven White
authored andcommitted
Merged PR 21152: Adding missing descriptions, and improving others
Adding missing descriptions, and improving others
1 parent aed8ae0 commit f59ebc9

13 files changed

Lines changed: 72 additions & 37 deletions

windows.devices.enumeration.pnp/pnpobjecttype.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public enum Windows.Devices.Enumeration.Pnp.PnpObjectType : int
1616
>
1717
> The alternative to **PnpObjectType** is the [Windows.Devices.Enumeration.DeviceInformationKind](/uwp/api/windows.devices.enumeration.deviceinformationkind) enum, which you can pass as a parameter to **Windows.Devices.Enumeration** APIs. For example, instead of using **PnpObjectType** when you create a **PnpObjectWatcher**, use **DeviceInformationKind** when you create a [DeviceWatcher](/uwp/api/windows.devices.enumeration.devicewatcher).
1818
19-
Indicates the type of device represented by the [PnpObject](pnpobject.md).
19+
Defines constants that specify the type of device represented by the [PnpObject](pnpobject.md).
2020

2121
## -enum-fields
2222

@@ -58,7 +58,7 @@ The [PnpObject](pnpobject.md) represents a device input panel.
5858

5959
### -field AssociationEndpointProtocol: 9
6060

61-
TBD
61+
Specifies that the [PnpObject](pnpobject.md) represents an association endpoint protocol.
6262

6363
## -remarks
6464

windows.devices.enumeration/deviceinformation_createfromidasync_1003420271.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ The type of [DeviceInformation](deviceinformation.md) object that you want to cr
3030

3131
### -param settings
3232

33-
Enumeration settings come from a device API's **GetDeviceEnumerationSettings** method, and contain opaque data. An object implementing this must also implement the **IDeviceEnumerationSettings** interface.
33+
The argument passed in *settings* is an object that implements **IDeviceEnumerationSettings**; but otherwise, the object is of an opaque marker class (that is, it has no public properties or methods). The purpose of *settings* is to retrieve extended parameters from a device-specific API for device-specific scenarios that aren't possible in the standard WDE API. You can think of the parameters like extra knobs that the API surface doesn't allow.
34+
35+
The *settings* object would come from a device API's **GetDeviceEnumerationSettings** method, and would contain opaque data. But currently there are no APIs that produce the object.
3436

3537
## -returns
3638

windows.devices.enumeration/deviceinformation_createfromidasync_728202765.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ An object for starting and managing the asynchronous creation of the [DeviceInfo
2525
The savedId variable in this example is a [DeviceInformation](deviceinformation.md) ID previously saved by the application, obtained from the [id](deviceinformation_id.md) property of the last-used [DeviceInformation](deviceinformation.md) object.
2626

2727
```javascript
28-
2928
// Create a DeviceInformation object from a saved ID
3029
var Enum = Windows.Devices.Enumeration;
3130
var DevInf = Enum.DeviceInformation;
@@ -40,7 +39,5 @@ The savedId variable in this example is a [DeviceInformation](deviceinformation.
4039

4140
```
4241

43-
44-
4542
## -see-also
46-
[CreateFromIdAsync(String, IIterable_1)](deviceinformation_createfromidasync_907774063.md)
43+
[CreateFromIdAsync(String, IIterable_1)](deviceinformation_createfromidasync_907774063.md)

windows.devices.enumeration/deviceinformation_createfromidasync_907774063.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ An object for starting and managing the asynchronous creation of the [DeviceInfo
2828
The following example builds a list of properties to include in the [DeviceInformation](deviceinformation.md) object to create from a [DeviceInformation](deviceinformation.md) ID.The savedId variable in this example is a [DeviceInformation](deviceinformation.md) ID previously saved by the application, obtained from the [id](deviceinformation_id.md) property of the last-used [DeviceInformation](deviceinformation.md) object.
2929

3030
```javascript
31-
3231
// Create a set of two additional properties
3332
var propertiesToRetrieve = new Array();
3433
propertiesToRetrieve.push("System.InterfaceClassGuid");
@@ -45,12 +44,7 @@ The following example builds a list of properties to include in the [DeviceInfor
4544
function (e) {
4645
displayError("Failed to create DeviceInformation: " + e.message);
4746
});
48-
49-
50-
5147
```
5248

53-
54-
5549
## -see-also
56-
[CreateFromIdAsync(String)](deviceinformation_createfromidasync_728202765.md)
50+
[CreateFromIdAsync(String)](deviceinformation_createfromidasync_728202765.md)

windows.devices.enumeration/deviceinformationcustompairing_pairingsetmembersrequested.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ public event Windows.Foundation.TypedEventHandler<Windows.Devices.Enumeration.De
1212

1313
## -description
1414

15-
TBD. For more info, and code examples, see [Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set).
15+
Raised when the member(s) of a pairing set have been requested. For more info, and code examples, see [Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set).
1616

1717
## -remarks
1818

windows.devices.enumeration/deviceinformationkind.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ public enum Windows.Devices.Enumeration.DeviceInformationKind : int
1111

1212
## -description
1313

14-
Represents the kind of [DeviceInformation](deviceinformation.md) object.
14+
Defines constants that specify a kind of [DeviceInformation](deviceinformation.md) object.
1515

1616
## -enum-fields
1717

@@ -73,7 +73,37 @@ The [Id](deviceinformation_id.md) for this object as a string.
7373

7474
### -field AssociationEndpointProtocol:9
7575

76-
TBD
76+
Specifies that the [DeviceInformation](deviceinformation.md) object represents a protocol through which association endpoints (AEPs) can be discovered. You can scope an association endpoint discovery to specific protocols by using the protocol ID. For example, the following selector scopes discovery to Bluetooth LE or Bluetooth Classic.
77+
78+
`System.Devices.Aep.ProtocolId:="{e0cbf06c-cd8b-4647-bb8a-263b43f0f974}"` or `DEVPKEY_Aep_ProtocolId:="{e0cbf06c-cd8b-4647-bb8a-263b43f0f974}"`.
79+
80+
System.Devices.Aep.ProtocolId is the protocol's name in propsys; and DEVPKEY_Aep_ProtocolId is the Win32 DEVPKEY.
81+
82+
Here's a representative example of what enumerating a protocol looks like, and how it matches up to the AEP properties (with annotations inside square brackets).
83+
84+
```console
85+
> pairtool /enum-protocols
86+
...
87+
Protocol ID: Bluetooth [DEVPKEY_Aep_ProviderName]
88+
Protocol Provider Name: Bluetooth
89+
Protocol Name: Bluetooth Classic
90+
Universal Protocol ID: {e0cbf06c-cd8b-4647-bb8a-263b43f0f974} [DEVPKEY_Aep_ProtocolId // <propertyDescription name="System.Devices.Aep.ProtocolId" formatID="{3B2CE006-5E61-4FDE-BAB8-9B8AAC9B26DF}" propID="5">]
91+
Protocol Provider Class ID: {4aa383d6-337a-43d3-a3fa-c14b26004130}
92+
93+
Protocol ID: BluetoothLE [DEVPKEY_Aep_ProviderName]
94+
Protocol Provider Name: BluetoothLE
95+
Protocol Name: Bluetooth Low Energy
96+
Universal Protocol ID: {bb7bb05e-5972-42b5-94fc-76eaa7084d49} [DEVPKEY_Aep_ProtocolId]
97+
Protocol Provider Class ID: {0829c308-d361-49f4-828b-506d552029ef}
98+
...
99+
> pairtool /enum-endpoints
100+
101+
BluetoothLE#BluetoothLEdc:46:28:6a:16:01-20:4c:03:45:07:ca
102+
1)DEVPKEY_Aep_ContainerId [SYS] (null) DEVPROP_TYPE_GUID 16 {72888bff-567a-54f9-861a-73a3f2df469c}
103+
...
104+
30)DEVPKEY_Aep_ProviderName [SYS] (null) DEVPROP_TYPE_STRING 24 "BluetoothLE"
105+
33)DEVPKEY_Aep_ProtocolId [SYS] (null) DEVPROP_TYPE_GUID 16 {bb7bb05e-5972-42b5-94fc-76eaa7084d49}
106+
```
77107

78108
## -remarks
79109

windows.devices.enumeration/devicepairingaddpairingsetmemberstatus.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,29 @@ public enum DevicePairingAddPairingSetMemberStatus
1212

1313
## -description
1414

15-
Defines constants that specify TBD. For more info, and code examples, see [Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set).
15+
Defines constants that specify a status value describing the result of adding member(s) to a pairing set. For more info, and code examples, see [Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set). See [DevicePairingSetMembersRequestedEventArgs.Status](./devicepairingsetmembersrequestedeventargs_status.md).
1616

1717
## -enum-fields
1818

1919
### -field AddedToSet: 0
2020

21-
Specifies that the device was successfully added to the set.
21+
Specifies that set member(s) were added successfully to the set. This status applies to a call to [DeviceInformationCustomPairing.AddPairingSetMember](./deviceinformationcustompairing_addpairingsetmember_1277113744.md), and indicates that you can expect *the successfully added set member(s)* to be in the [DevicePairingSetMembersRequestedEventArgs.PairingSetMembers](./devicepairingsetmembersrequestedeventargs_pairingsetmembers.md) vector.
2222

2323
### -field CouldNotBeAddedToSet: 1
2424

25-
Specifies that we failed to add set member(s).
25+
Specifies that set member(s) couldn't be added to the set. This status applies to a call to [DeviceInformationCustomPairing.AddPairingSetMember](./deviceinformationcustompairing_addpairingsetmember_1277113744.md), and indicates that you can expect *the set member(s) that couldn't be added* to be in the [DevicePairingSetMembersRequestedEventArgs.PairingSetMembers](./devicepairingsetmembersrequestedeventargs_pairingsetmembers.md) vector.
2626

2727
### -field SetDiscoveryNotAttemptedByProtocol: 2
2828

29-
Specifies TBD
29+
Specifies that the protocol didn't attempt to discover set members. The protocol probably doesn't support it.
3030

3131
### -field SetDiscoveryCompletedByProtocol: 3
3232

33-
Specifies TBD
33+
Specifies that the protocol successfully enumerated all set members. No further discovery will happen.
3434

3535
### -field SetDiscoveryPartiallyCompletedByProtocol: 4
3636

37-
Specifies TBD
37+
Specifies that the protocol discovered some set members, but not all of them. No further discovery will happen.
3838

3939
### -field Failed: 5
4040

@@ -44,4 +44,4 @@ Specifies that an unknown failure occurred, for which we have no mapping.
4444

4545
## -see-also
4646

47-
[Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set)
47+
[DevicePairingSetMembersRequestedEventArgs.Status](./devicepairingsetmembersrequestedeventargs_status.md), [Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set)

windows.devices.enumeration/devicepairingkinds.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ public enum Windows.Devices.Enumeration.DevicePairingKinds : uint
1111
# DevicePairingKinds
1212

1313
## -description
14-
Indicates the kinds of pairing supported by your application or requested by the system. As an input value, use this value to indicate what kinds of pairing your application supports. When this datatype is received as an output value, it indicates the kind of pairing requested by the system. In this case, your code will need to respond accordingly.
14+
15+
Defines constants that specify kinds of pairing supported by your application or requested by the system. As an input value, use this value to indicate what kinds of pairing your application supports. When this datatype is received as an output value, it indicates the kind of pairing requested by the system; in that case, your code will need to respond accordingly.
1516

1617
## -enum-fields
1718

@@ -34,11 +35,10 @@ The application must display the given PIN to the user and ask the user to confi
3435
The application must request a user name and password from the user. With a value of **ProvidePasswordCredential**, call [AcceptWithPasswordCredential](devicepairingrequestedeventargs_acceptwithpasswordcredential_1073078053.md) from the event args of the [PairingRequested](deviceinformationcustompairing_pairingrequested.md) event handler to accept the pairing. Pass in the [PasswordCredential](../windows.security.credentials/passwordcredential.md) that encapsulates the user name and password as a parameter.
3536

3637
### -field ProvideAddress:32
37-
38-
TBD
38+
Specifies that your application must provide an address from the device. This is typically used for directed discovery over a network protocol such as IPP or UPnP, where the application already knows the IP/address/URL of the device. With a value of **ProvideAddress**, you should call [DevicePairingRequestedEventArgs.AcceptWithAddress](./devicepairingrequestedeventargs_acceptwithaddress_1238468511.md) on the event args of the [DeviceInformationCustomPairing.PairingRequested](/uwp/api/windows.devices.enumeration.deviceinformationcustompairing.pairingrequested) event handler, if you want the pairing to complete. Pass in the address as a parameter.
3939

4040
## -remarks
41-
This value is a collection of flags. It is possible to have multiple values set for a single pairing action.
41+
This value is a collection of flags. It's possible to have multiple values set for a single pairing action.
4242

4343
### Version history
4444

windows.devices.enumeration/devicepairingrequestedeventargs_acceptwithaddress_1238468511.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Accepts a [PairingRequested](deviceinformationcustompairing_pairingrequested.md)
1818

1919
### -param address
2020

21-
TBD
21+
Your app must provide an address from the device. This is typically used for directed discovery over a network protocol such as IPP or UPnP, where the application already knows the IP/address/URL of the device. You should call **AcceptWithAddress** if you want the pairing to complete. Pass in the address as a parameter.
2222

2323
## -remarks
2424

windows.devices.enumeration/devicepairingsetmembersrequestedeventargs.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ public sealed class DevicePairingSetMembersRequestedEventArgs
1212

1313
## -description
1414

15-
TBD
15+
Event arguments passed to your handler for the [DeviceInformationCustomPairing.PairingSetMembersRequested](./deviceinformationcustompairing_pairingsetmembersrequested.md) event, which is raised when the member(s) of a pairing set have been requested.
1616

17-
This is the type of the event args for the [DeviceInformationCustomPairing.PairingSetMembersRequested](./deviceinformationcustompairing_pairingsetmembersrequested.md) event. For more info, and code examples, see [Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set).
17+
**DevicePairingSetMembersRequestedEventArgs** contains: a status indicating success or failure; a vector of the devices/endpoints that were added to the set, or that failed to be added to the set, depending on that status; and info about the parent device.
18+
19+
For more info, and code examples, see [Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set).
1820

1921
## -remarks
2022

0 commit comments

Comments
 (0)