Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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>
<Extension>
<Protocol>

Syntax

<Protocol Name = A string between 3 and 39 characters in length that contains numbers, lowercased letters, or a hyphen ('-'). >

  <!-- Child elements -->
  ( Logo?
  & DisplayName?
  )

</Protocol>

Key

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

Attributes and Elements

Attributes

AttributeDescriptionData typeRequiredDefault value
Name

The name of the URI scheme, such as "mailto". This name must be unique for the package.

A string between 3 and 39 characters in length that contains numbers, lowercased letters, or a hyphen ('-').Yes

 

Child Elements

Child ElementDescription
DisplayName

A friendly name that can be displayed to users.

Logo

A path to a file that contains an image.

 

Parent Elements

Parent ElementDescription
Extension (in type: CT_ApplicationExtensions)

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>
      <Extension Category="windows.protocol">
        <Protocol Name="alsdk" />
      </Extension>
    </Extensions>
  </Application>
</Applications>

See also

Tasks
How to handle URI activation
Concepts
App contracts and extensions

Requirements

Namespace

http://schemas.microsoft.com/appx/2010/manifest

 

 

Show:
© 2015 Microsoft