CommandLineActivatedEventArgs Classe

Définition

Espace de noms:

Windows.ApplicationModel.Activation

Fournit des informations, telles que les arguments de ligne de commande, lorsqu’une application est activée à partir de la ligne de commande.

public ref class CommandLineActivatedEventArgs sealed : IActivatedEventArgsWithUser, ICommandLineActivatedEventArgs

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class CommandLineActivatedEventArgs final : IActivatedEventArgsWithUser, ICommandLineActivatedEventArgs

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class CommandLineActivatedEventArgs : IActivatedEventArgsWithUser, ICommandLineActivatedEventArgs

Public NotInheritable Class CommandLineActivatedEventArgs
Implements IActivatedEventArgsWithUser, ICommandLineActivatedEventArgs

Héritage

Object Platform::Object IInspectable CommandLineActivatedEventArgs

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute

Implémente

IActivatedEventArgs IActivatedEventArgsWithUser ICommandLineActivatedEventArgs

Configuration requise pour Windows

Famille d’appareils	Windows 10 Fall Creators Update (introduit dans 10.0.16299.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v5.0)

Exemples

Voici un exemple de gestion d’un lancement en ligne de commande :

protected override void OnActivated(IActivatedEventArgs args)
{
    string activationArgString = string.Empty;
    string activationPath = string.Empty;
    string cmdLineString = string.Empty;

    // Existing behavior to differentiate different activation kinds,
    // and to extract any argument payload.
    switch (args.Kind)
    {
        case ActivationKind.Launch:
            var launchArgs = args as LaunchActivatedEventArgs;
            activationArgString = launchArgs.Arguments;
            break;

        // A new ActivationKind for console activation of a windowed app.
        case ActivationKind.CommandLineLaunch:
            CommandLineActivatedEventArgs cmdLineArgs = args as CommandLineActivatedEventArgs;
            CommandLineActivationOperation operation = cmdLineArgs.Operation;
            cmdLineString = operation.Arguments;
            activationPath = operation.CurrentDirectoryPath;
            break;
    }

    // Parse the trusted activation arguments.
    ParseTrustedArgs(activationArgString);

    // Parse the untrusted command-line arguments.
    ParseUntrustedArgs(activationPath, cmdLineString);

    // Since we did not take a deferral, the calling app gets the result
    // as soon as this method returns. Since we did not set an exit code,
    // the calling app gets a default exit code as the result.
}    

Remarques

Une application UWP peut être activée à partir de l’écran de démarrage|Exécutez dans Windows, à partir de la ligne de commande dans PowerShell, de l’invite de commandes DOS ou d’un autre processus Win32 qui appelle CreateProcess().

Pour être activée à partir de la ligne de commande, votre application doit s’inscrire à la catégorie d’extension « AppExecutionAlias » dans son manifeste.

<uap5:Extension Category="windows.appExecutionAlias" Executable="FruitSalad.exe" EntryPoint="Windows.FruitSalad.Bananas.App">
    <uap5:AppExecutionAlias >
        <uap5:ExecutionAlias Alias="Fs.exe" />
    </uap5:AppExecutionAlias>
</uap5:Extension>

Une fois que vous vous êtes inscrit dans votre manifeste, votre application peut être activée à partir de la ligne de commande. Lorsque votre application est activée, vous pouvez utiliser les informations de l’événement pour identifier l’activation de l’appel et extraire les paramètres qui vous aident à terminer l’appel pour l’utilisateur.

Propriétés

Kind	Obtient le type d’activation qui a lancé l’application.
Operation	Obtient des informations sur l’activation de l’application, telles que les arguments fournis et le chemin du répertoire actif.
PreviousExecutionState	Obtient l’état d’exécution de l’application avant son activation.
SplashScreen	Obtient des informations sur la transition de l’écran de démarrage à l’application activée.
User	Obtient l’utilisateur pour lequel l’application a été activée.