AppInstance.GetActivatedEventArgs Method

Definition

Namespace:

Microsoft.Windows.AppLifecycle

Retrieves the event arguments for an app activation that was registered by using one of the static methods of the ActivationRegistrationManager class.

public:
 virtual AppActivationArguments ^ GetActivatedEventArgs() = GetActivatedEventArgs;

AppActivationArguments GetActivatedEventArgs();

public AppActivationArguments GetActivatedEventArgs();

function getActivatedEventArgs()

Public Function GetActivatedEventArgs () As AppActivationArguments

Returns

AppActivationArguments

An object that contains the activation type and the data payload, or null. See Remarks.

Remarks

The AppActivationArguments object returned is limited to those activation kinds that are supported in the Windows App SDK. As of version 1.0, those are Launch, File, Protocol, and StartupTask. For other activation kinds, GetActivatedEventArgs returns null.

For packaged apps, this method wraps the Windows.ApplicationModel.AppInstance.GetActivatedEventArgs method, and therefore returns the same value. Also for packaged apps, this method will only return the arguments the first time it is called in an app. So, you should call it as early as possible during activation, as the arguments may become unavailable later.

See also

• App instancing