Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 2.46 KB

peerfinder_start_1587696324.md

File metadata and controls

44 lines (27 loc) · 2.46 KB
-api-id -api-type -api-device-family-note
M:Windows.Networking.Proximity.PeerFinder.Start
winrt method
xbox

Windows.Networking.Proximity.PeerFinder.Start

-description

Makes an app discoverable to remote peers.

-remarks

You can call the Start method to begin the process of finding a peer app and to make your app discoverable to remote peers that call the FindAllPeersAsync method. A peer is a device that has an app running in the foreground with a matching AppId. A peer can also have a matching Browse Id that's specified as an alternate identity. For more information, see AlternateIdentities.

You can connect to only one peer at a time if your app is in the peer or client role. If your app is in the host role, you can connect up to 5 clients at a time.

When an app is activated by tapping a nearby device, the activation parameters indicate whether the PeerFinder should be started or if the app was launched with activation arguments. The format of the activation parameters is "Windows.Networking.Proximity.PeerFinder:StreamSocket Role=<Host|Client>". For more information, see the "Activating apps using Proximity" section of Supporting Proximity and Tapping.

Important

Always set the DisplayName property to a unique value for your app before you call the Start method.

Windows Phone 8

Wi-Fi Direct is not supported on Windows Phone 8.

-examples

[!code-csharpConnect_CS]

[!code-vbConnect_CS]

-see-also

AlternateIdentities, Start(String), Proximity and Tapping (C#/VB/C++), Proximity sample

-capabilities

proximity ID_CAP_PROXIMITY [Windows Phone], ID_CAP_PROXIMITY [Windows Phone], ID_CAP_NETWORKING [Windows Phone], ID_CAP_NETWORKING [Windows Phone]