Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
uap:Protocol
Declares an app extensibility point of type windows.protocol. A URI association indicates that the app is registered to handle URIs with the specified scheme.
Element hierarchy
<Package>
└─ <Applications>
└─ <Application>
└─ <Extensions>
└─ <uap:Extension>
└─ <uap:Protocol>
Syntax
<uap:Protocol
Name = 'A required string with a value between 2 and 2048 characters in length.'
DesiredView = 'An optional string that can have one of the following values: "default", "useLess", "useHalf", "useMore", or "useMinimum".'
ReturnResults = 'An optional string that can have one of the following values: "none", "always", or "optional".' >
<!-- Child elements -->
uap:Logo?
uap:DisplayName?
uap:MigrationProgIds?
uap:ProgId?
uap:ProgId?
</uap:Protocol>
Key
? optional (zero or one)
Attributes
| Attribute | Description | Data type | Required | Default value |
|---|---|---|---|---|
| Name | The name of the URI scheme (such as mailto). This name must be unique for the package. |
A string with a value between 2 and 2048 characters in length. | Yes | |
| DesiredView | The desired amount of screen space to use when the appointment launches. | An optional string that can have one of the following values: default, useLess, useHalf, useMore, useMinimum. | No | |
| ReturnResults | Specifies whether the app returns a value when invoked via a URI activation. | An optional string that can have one of the following values: none, always, optional. | No |
Child elements
| Child element | Description |
|---|---|
| uap:Logo | A path to a file that contains an image. |
| uap:DisplayName | A friendly name that can be displayed to users. |
| rescap3:MigrationProgIds | Contains programmatic identifier (ProgID) values that describes the application, component, and version of each desktop application from which you want to inherit file associations. |
| previewappcompat:ProgId | A programmatic identifier (ProgID) that can be associated with a CLSID. The ProgID identifies a class but with less precision than a CLSID because it is not guaranteed to be globally unique. |
| desktop7:ProgId | A programmatic identifier (ProgID) that can be associated with a CLSID. The ProgID identifies a class but with less precision than a CLSID because it is not guaranteed to be globally unique. |
Parent elements
| Parent element | Description |
|---|---|
| uap:Extension | Declares an extensibility point for the app. |
Requirements
| Item | Value |
|---|---|
| Namespace | http://schemas.microsoft.com/appx/manifest/uap/windows10 |
| Minimum OS Version | Windows 10 version 1511 (Build 10586) |
Remarks
Examples
The following example is taken from the package manifest of one of the SDK samples.
<Applications>
<Application
Id="App"
StartPage="default.html">
<Extensions>
<uap:Extension
Category="windows.protocol">
<uap:Protocol
Name="alsdk" />
</uap:Extension>
</Extensions>
</Application>
</Applications>
See also
Tasks How to handle URI activation
Concepts App contracts and extensions
Feedback
Was this page helpful?