Skip to content

Commit

Permalink
Merged PR 15876: fixing GitHub issues, and linking to the
Browse files Browse the repository at this point in the history
fixing GitHub issues, and linking to the recently-rescued-from-previous-versions GUID topic
  • Loading branch information
Steven White authored and Steven White committed Oct 23, 2019
1 parent 070e627 commit 7258ec6
Show file tree
Hide file tree
Showing 157 changed files with 169 additions and 167 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Gets and sets the group identifier.
The group identifier.

## -remarks
To reduce collisions with other group identifiers, consider including your domain name in the group identifier. For example: `"com.contoso.appname.tasks"`. Or use the string form of a GUID.
To reduce collisions with other group identifiers, consider including your domain name in the group identifier. For example: `"com.contoso.appname.tasks"`. Or use the string form of a [GUID](/windows/win32/api/guiddef/ns-guiddef-guid).

## -see-also
[Launching, resuming, and background tasks](https://docs.microsoft.com/windows/uwp/launch-resume/index)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The group ID.
The friendly name for this group.

## -remarks
To reduce collisions with other group identifiers, consider including your domain name in the group ID. For example: `"com.contoso.appname.tasks"`. Or use the string form of a GUID.
To reduce collisions with other group identifiers, consider including your domain name in the group ID. For example: `"com.contoso.appname.tasks"`. Or use the string form of a [GUID](/windows/win32/api/guiddef/ns-guiddef-guid).

The friendly name can be useful for debugging purposes if your group IDs are difficult to distinguish.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Creates a **BackgroundTaskRegistrationGroup** with the specified group ID.
The group ID.

## -remarks
To reduce collisions with other group identifiers, consider including your domain name in the group identifier. For example: `"com.contoso.appname.tasks"`. Or use the string form of a GUID.
To reduce collisions with other group identifiers, consider including your domain name in the group identifier. For example: `"com.contoso.appname.tasks"`. Or use the string form of a [GUID](/windows/win32/api/guiddef/ns-guiddef-guid).

## -see-also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The trigger identifier that uniquely identifies the background task that needs t
The trigger identifier string.

## -remarks
Consider using a GUID in string form.
Consider using a [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) in string form.

## -see-also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Cancels the upgrade to a VoIP call.

## -parameters
### -param callUpgradeGuid
The GUID for the VoIP call.
The [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) for the VoIP call.

## -remarks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Makes a request of the system to create an outgoing video call that will replace

## -parameters
### -param callUpgradeGuid
The GUID of the call.
The [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) of the call.

### -param context
A string that is passed to the associated foreground app as a deep link. This might be a contact name or other data that can be used to populate the app's UI more quickly. The maximum length is 128 characters. This parameter must be non-null and must refer to a task defined in the app's manifest file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Terminates a cellular call in order to upgrade to a VoIP call.

## -parameters
### -param callUpgradeGuid
The GUID for the VoIP call.
The [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) for the VoIP call.

## -remarks

Expand Down
6 changes: 3 additions & 3 deletions windows.applicationmodel.store/currentapp_appid.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ public System.Guid AppId { get; }
# Windows.ApplicationModel.Store.CurrentApp.AppId

## -description
Gets the GUID generated by the Windows Store when your app has been certified for listing in the Windows Store.
Gets the [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) generated by the Windows Store when your app has been certified for listing in the Windows Store.

> [!NOTE]
> Once your app is in the Windows Store, future app updates or changes to the app description will not result in a change to the CurrentApp.AppId.
## -property-value
The GUID that identifies the app in the Windows Store.
The [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) that identifies the app in the Windows Store.

## -remarks
To get a link to your app within the Windows Store, which references the same GUID, use [LinkUri](currentapp_linkuri.md).
To get a link to your app within the Windows Store, which references the same [GUID](/windows/win32/api/guiddef/ns-guiddef-guid), use [LinkUri](currentapp_linkuri.md).

## -examples

Expand Down
4 changes: 2 additions & 2 deletions windows.applicationmodel.store/currentappsimulator_appid.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ public System.Guid AppId { get; }
## -description
Gets a simulated app ID. Since [CurrentAppSimulator](currentappsimulator.md) is intended only for testing during app development, the returned CurrentAppSimulator.AppId will contain only 0's.

Once your app is listed on the Windows Store, [CurrentApp.AppId](currentapp_appid.md) will get the GUID generated during app on-boarding and used to list your app within the Windows Store catalog.
Once your app is listed on the Windows Store, [CurrentApp.AppId](currentapp_appid.md) will get the [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) generated during app on-boarding and used to list your app within the Windows Store catalog.

> [!NOTE]
> App updates or changes to the app description will not result in a change to the [CurrentApp.AppId](currentapp_appid.md).
## -property-value
The GUID that identifies the app in the Windows Store.
The [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) that identifies the app in the Windows Store.

## -remarks
Uses the **AppId** element in the WindowsStoreProxy.xml file as the data source for the members of the returned object. For more information, see [Using the WindowsStoreProxy.xml file with CurrentAppSimulator](https://docs.microsoft.com/windows/uwp/monetize/in-app-purchases-and-trials-using-the-windows-applicationmodel-store-namespace).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ public IAsyncOperation<UserDataAccount> UserDataAccountStore.CreateAccountAsync(
# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync

## -description
Asynchronously creates a user data account, specifying a displayable user name, a GUID that identifies the app in the Microsoft Store, and the enterprise identity associated with the user account.
Asynchronously creates a user data account, specifying a displayable user name, a [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) that identifies the app in the Microsoft Store, and the enterprise identity associated with the user account.

## -params

## -param userDisplayName
A string containing the user name that is suitable for display.

## -param packageRelativeAppId
The GUID that identifies the app in the Microsoft Store.
The [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) that identifies the app in the Microsoft Store.

## -param enterpriseId
The enterprise identity associated with the user data account.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ public Windows.Foundation.IAsyncOperation<Windows.ApplicationModel.UserDataAccou
# Windows.ApplicationModel.UserDataAccounts.UserDataAccountStore.CreateAccountAsync

## -description
Asynchronously creates a user data account, specifying a displayable user name and a GUID that identifies the app in the Microsoft Store.
Asynchronously creates a user data account, specifying a displayable user name and a [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) that identifies the app in the Microsoft Store.

## -parameters
### -param userDisplayName
A string containing the user name that is suitable for display.

### -param packageRelativeAppId
The GUID that identifies the app in the Microsoft Store.
The [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) that identifies the app in the Microsoft Store.

## -returns
Returns the newly created [UserDataAccount](userdataaccount.md).
Expand Down
2 changes: 1 addition & 1 deletion windows.devices.alljoyn/alljoynaboutdata_appid.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public System.Guid AppId { get; set; }
A globally unique identifier associated with the app.

## -property-value
A GUID representing the globally unique identifier.
A [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) representing the globally unique identifier.

## -remarks

Expand Down
2 changes: 1 addition & 1 deletion windows.devices.alljoyn/alljoynaboutdataview_appid.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public System.Guid AppId { get; }
A globally unique identifier associated with the app.

## -property-value
A GUID representing the globally unique identifier.
A [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) representing the globally unique identifier.

## -remarks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ public Windows.Foundation.Collections.IVector<System.Guid> ServiceUuids { get; }
# Windows.Devices.Bluetooth.Advertisement.BluetoothLEAdvertisement.ServiceUuids

## -description
The list of service UUIDs in 128-bit GUID format in a [BluetoothLEAdvertisement](bluetoothleadvertisement.md).
The list of service UUIDs in 128-bit [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) format in a [BluetoothLEAdvertisement](bluetoothleadvertisement.md).

## -property-value
The list of service UUIDs in 128-bit GUID format. This property aggregates all the 16-bit, 32-bit and 128-bit service UUIDs into a single list.
The list of service UUIDs in 128-bit [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) format. This property aggregates all the 16-bit, 32-bit and 128-bit service UUIDs into a single list.

## -remarks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Creates a suitable AQS Filter string for use with the [CreateWatcher](../windows

## -parameters
### -param serviceUuid
A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object.
A 128-bit Bluetooth GATT Service UUID, represented as a standard [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) object.

## -returns
A suitable AQS Selector String which can be passed as a parameter to the [CreateWatcher](../windows.devices.enumeration/deviceinformation_createwatcher_4958831.md) method, in order to retrieve a GATT service instance path.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Gets the included services from the serviceUuid that is associated with this Gat
## -parameters

### -param serviceUuid
A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object.
A 128-bit Bluetooth GATT Service UUID, represented as a standard [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) object.

### -param cacheMode
The cache mode.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Gets the included services from the serviceUuid that is associated with this Gat
## -parameters

### -param serviceUuid
A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object.
A 128-bit Bluetooth GATT Service UUID, represented as a standard [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) object.

## -returns
An asynchronous operation that completes with a GattDeviceServicesResult object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ public System.Guid Uuid { get; }
# Windows.Devices.Bluetooth.GenericAttributeProfile.GattDeviceService.Uuid

## -description
The GATT Service UUID associated with this GattDeviceService.
Gets the GATT Service UUID associated with this **GattDeviceService**.

## -property-value

**A 128-bit Bluetooth GATT Service UUID, represented as a standard GUID object.**
**A 128-bit Bluetooth GATT Service UUID, represented as a standard [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) object.**


## -remarks
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Gets a [BluetoothAdapter](bluetoothadapter.md) object identified by the given [D
## -parameters

### -param deviceId
The DeviceId value that identifies the BluetoothAdapter instance. This is a composite string combining registry information that includes the MatchingDeviceId, the MAC address, and a GUID representing a device class. This is different than Windows.Devices.Enumeration.DeviceInformation.Id. However, both contain the MAC address of the Bluetooth radio device embedded within the identifier string.
The DeviceId value that identifies the BluetoothAdapter instance. This is a composite string combining registry information that includes the MatchingDeviceId, the MAC address, and a [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) representing a device class. This is different than Windows.Devices.Enumeration.DeviceInformation.Id. However, both contain the MAC address of the Bluetooth radio device embedded within the identifier string.

## -returns
After the asynchronous operation completes, returns the [BluetoothAdapter](bluetoothadapter.md) object identified by the given [DeviceId](bluetoothadapter_deviceid.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,13 @@ Gets the radio represented by this Bluetooth adapter.
Returns an asynchronous operation that completes with the Radio.

## -remarks
When called from a UWP app, there is no architecture requirement. This method will work on the native architecture, as well as x86 architecture on x64 or ARM64 architectures.

When this method is called from a desktop application (Win32), it will only retrieve radio instances when the application is in the native architecture, and x86 architectures running on x64 architectures will not see any radio instances.

## -see-also

## -examples


## -capabilities
bluetooth
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The Device Interface Class GUID of the device interface to create a device selec
The device selector.

## -remarks
For more info about the Device Interface Class GUID, see [Overview of Device Interface Classes](https://docs.microsoft.com/windows-hardware/drivers/install/overview-of-device-interface-classes).
For more info about the Device Interface Class [GUID](/windows/win32/api/guiddef/ns-guiddef-guid), see [Overview of Device Interface Classes](https://docs.microsoft.com/windows-hardware/drivers/install/overview-of-device-interface-classes).

## -examples

Expand Down
6 changes: 3 additions & 3 deletions windows.devices.enumeration/deviceinformationkind.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The [Id](deviceinformation_id.md) for this object is the device interface id, or

The [DeviceInformation](deviceinformation.md) object represents a device container. *DeviceContainer* objects describe a collection of device objects that exist in the same physical device. For example, a multi-function printer may have several different devices included, but they would all exist as part of the parent *DeviceContainer* object.

The [Id](deviceinformation_id.md) for this object is the device container GUID as a string.
The [Id](deviceinformation_id.md) for this object is the device container [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) as a string.

### -field Device:3

Expand All @@ -45,7 +45,7 @@ The [Id](deviceinformation_id.md) for this object is the device instance id for

The [DeviceInformation](deviceinformation.md) object represents a device interface class. Every *DeviceInterface* object belongs to a certain *DeviceInterfaceClass*. This is similar to a contract definition. These contracts are represented with an id and properties, just like every other PnP object. *DeviceInterfaceClass* objects contain little more information than a unique identifier and possibly a name.

The [Id](deviceinformation_id.md) for this object is the device interface class GUID as a string.
The [Id](deviceinformation_id.md) for this object is the device interface class [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) as a string.

### -field AssociationEndpoint:5

Expand All @@ -57,7 +57,7 @@ The [Id](deviceinformation_id.md) for this object.

The [DeviceInformation](deviceinformation.md) object represents an association endpoint (AEP) container. An *AssociationEndpointContainer* object represents a single physical device that might have more than one *AssociationEndpoint* objects associated with it. For example, if a television supports two different network protocols, the *AssociationEndpointContainer* would be the television. It would also have two *AssociationEndpoint* objects to represent each protocol.

The [Id](deviceinformation_id.md) for this object is the AEP container GUID as a string.
The [Id](deviceinformation_id.md) for this object is the AEP container [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) as a string.

### -field AssociationEndpointService:7

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A specific set of properties describing a unique IPerceptionFrameProvider.
## -remarks
The properties are:

Id - A unique identifier of the IPerceptionFrameProvider, for example, a GUID or "com.contoso.depthcamera.x500.serialNumber1234".
Id - A unique identifier of the IPerceptionFrameProvider, for example, a [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) or "com.contoso.depthcamera.x500.serialNumber1234".
+ This id must be persistent across reboots.
+ This id must be different between devices for a single manufacturer.
+ This id must be approximately globally unique such that there are no conflicts on any one host.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public string Id { get; set; }
Gets or sets the unique identifier of the IPerceptionFrameProvider.

## -property-value
The unique identifier of the IPerceptionFrameProvider, for example, a GUID, or "com.contoso.depthcamera.x500.serialNumber1234".
The unique identifier of the IPerceptionFrameProvider, for example, a [GUID](/windows/win32/api/guiddef/ns-guiddef-guid), or "com.contoso.depthcamera.x500.serialNumber1234".

## -remarks

Expand Down
2 changes: 1 addition & 1 deletion windows.devices.usb/usbdevice.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Represents a USB device. The object provides methods and properties that an app
## -remarks
Before getting a reference to the UsbDevice object, you must have one of these identifiers:
+ The vendor and product identifiers for the physical device. Those identifiers are part of the hardware ID string. You can obtain that string from the [Models](https://docs.microsoft.com/windows-hardware/drivers/install/inf-models-section) section in the INF file. Alternatively, if WinUSB was loaded based on the compatible ID specified in the device descriptor, you can derive the identifiers from the **Hardware Ids** property in **Device Manager**. For example, if **Hardware Id** is "USB\VID_045E&amp;PID_078E", vendor ID is "0x045E" and product Id is "0x078E".
+ The device interface GUID. You can obtain that GUID from the **DeviceInterfaceGuids** registry entry under this key:**HKEY_LOCAL_MACHINE**\**System**\**CurrentControlSet**\**Enum**\**USB**\***&lt;Device Identifier&gt;***\***&lt;Instance Identifier&gt;***\**Device Parameters**
+ The device interface [GUID](/windows/win32/api/guiddef/ns-guiddef-guid). You can obtain that GUID from the **DeviceInterfaceGuids** registry entry under this key:**HKEY_LOCAL_MACHINE**\**System**\**CurrentControlSet**\**Enum**\**USB**\***&lt;Device Identifier&gt;***\***&lt;Instance Identifier&gt;***\**Device Parameters**
+ The device's class, subclass, and protocol codes. You can obtain that information from the **CompatibleIds** registry entry, found under the **Device Parameters** key.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public string GetDeviceSelector(System.Guid winUsbInterfaceClass)
# Windows.Devices.Usb.UsbDevice.GetDeviceSelector

## -description
Gets an Advanced Query Syntax (AQS) string, based on the device interface GUID identifier, specified by the app. The app passes the string to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync_1257462890.md) in order to find a specific type of USB device.
Gets an Advanced Query Syntax (AQS) string, based on the device interface [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) identifier, specified by the app. The app passes the string to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync_1257462890.md) in order to find a specific type of USB device.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public string GetDeviceSelector(System.UInt32 vendorId, System.UInt32 productId,
# Windows.Devices.Usb.UsbDevice.GetDeviceSelector

## -description
Gets an Advanced Query Syntax (AQS) string, based on vendor, product, and device interface GUID identifiers, specified by the app. The app passes the string to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync_1257462890.md) in order to find a specific type of USB device.
Gets an Advanced Query Syntax (AQS) string, based on vendor, product, and device interface [GUID](/windows/win32/api/guiddef/ns-guiddef-guid) identifiers, specified by the app. The app passes the string to [DeviceInformation.FindAllAsync](../windows.devices.enumeration/deviceinformation_findallasync_1257462890.md) in order to find a specific type of USB device.

## -parameters
### -param vendorId
Expand Down
Loading

0 comments on commit 7258ec6

Please sign in to comment.