ActivationRegistrationManager.RegisterForProtocolActivation Method

Definition

Namespace:

Microsoft.Windows.AppLifecycle

Registers to activate the app when the specified URI scheme is executed via ShellExecute, Launcher.LaunchUriAsync, or the command-line.

public:
 static void RegisterForProtocolActivation(Platform::String ^ scheme, Platform::String ^ logo, Platform::String ^ displayName, Platform::String ^ exePath);

 static void RegisterForProtocolActivation(winrt::hstring const& scheme, winrt::hstring const& logo, winrt::hstring const& displayName, winrt::hstring const& exePath);

public static void RegisterForProtocolActivation(string scheme, string logo, string displayName, string exePath);

function registerForProtocolActivation(scheme, logo, displayName, exePath)

Public Shared Sub RegisterForProtocolActivation (scheme As String, logo As String, displayName As String, exePath As String)

Parameters

scheme

String

Platform::String

winrt::hstring

The URI scheme to register for activations, such as https.

logo

String

Platform::String

winrt::hstring

The path to the image or resource used by Windows for the URI scheme. For packaged apps, this parameter is a package-relative path to an image file. For unpackaged, this parameter is a literal filepath to a binary file (DLL, EXE) plus a resource index.

displayName

String

Platform::String

winrt::hstring

This display name used by Windows for the URI scheme.

exePath

String

Platform::String

winrt::hstring

The path to the executable to be activated. If you pass an empty string, the current exectuable will be activated by default. Typically this parameter is specified if the caller of this method is the app's installer rather than the app itself.

See also

• UnregisterForProtocolActivation(String, String)