Edit

uap:Protocol (Windows 10)

  • Article

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 string with a value between 2 and 39 characters in length that contains numbers, lowercase letters, periods ("."), plus signs ("+"), or dashes ("-"). The string cannot start with a period (".").'
  DesiredView = 'A 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", "optional".' >

  <!-- Child elements -->
  uap:Logo?
  & uap:DisplayName?
  & desktop7:ProgId
</uap:Protocol>

Key

?   optional (zero or one) &   interleave connector (may occur in any order)

Attributes and elements

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 39 characters in length that contains numbers, lowercase letters, periods (.), plus signs (+), or dashes (-). The string cannot start with a period (.). Yes
DesiredView The desired amount of screen space to use when the appointment launches. A string that can have one of the following values: default, useLess, useHalf, useMore, or 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" (does not return a value), "always" (URI activation will always return a result), "optional" (URI activation will return a result if it is activated for results using LaunchUriForResultsAndContinueAsync). No

Child elements

Child element Description
uap:DisplayName A friendly name that can be displayed to users.
uap:Logo A path to a file that contains an image.
desktop7:ProgId A programmatic identifier (ProgID) that can be associated with a CLSID.

Parent elements

Parent element Description
uap:Extension Declares an extensibility point for the app.

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

Requirements

Item Value
Namespace http://schemas.microsoft.com/appx/manifest/uap/windows10
Minimum OS Version Windows 10 version 1511 (Build 10586)