Share via

Comment écrire une applet de commande

  • Article

Cet article explique comment écrire une applet de commande. L' Send-Greeting applet de commande prend un nom d’utilisateur unique comme entrée, puis écrit un message d’accueil à cet utilisateur. Bien que l’applet de commande n’effectue pas de nombreuses tâches, cet exemple illustre les principales sections d’une applet de commande.

Étapes d’écriture d’une applet de commande

  1. Pour déclarer la classe en tant qu’applet de commande, utilisez l’attribut d' applet de commande. L’attribut d' applet de commande spécifie le verbe et le nom du nom de l’applet de commande.

    Pour plus d’informations sur l’attribut d' applet de commande, consultez déclaration CmdletAttribute.

  2. Spécifiez le nom de la classe.

  3. Spécifiez que l’applet de commande dérive de l’une des classes suivantes :

  4. Pour définir les paramètres de l’applet de commande, utilisez l’attribut Parameter . Dans ce cas, un seul paramètre obligatoire est spécifié.

    Pour plus d’informations sur l’attribut de paramètre , consultez déclaration ParameterAttribute.

  5. Substituez la méthode de traitement d’entrée qui traite l’entrée. Dans ce cas, la méthode System. Management. Automation. applet de commande. ProcessRecord est remplacée.

  6. Pour écrire le message d’accueil, utilisez la méthode System. Management. Automation. applet de commande. WriteObject. Le message d’accueil s’affiche au format suivant :

    Hello <UserName>!

Exemple

using System.Management.Automation;  // Windows PowerShell assembly.

namespace SendGreeting
{
  // Declare the class as a cmdlet and specify the
  // appropriate verb and noun for the cmdlet name.
  [Cmdlet(VerbsCommunications.Send, "Greeting")]
  public class SendGreetingCommand : Cmdlet
  {
    // Declare the parameters for the cmdlet.
    [Parameter(Mandatory=true)]
    public string Name
    {
      get { return name; }
      set { name = value; }
    }
    private string name;

    // Override the ProcessRecord method to process
    // the supplied user name and write out a
    // greeting to the user by calling the WriteObject
    // method.
    protected override void ProcessRecord()
    {
      WriteObject("Hello " + name + "!");
    }
  }
}

Voir aussi

System. Management. Automation. applet de commande

System. Management. Automation. PSCmdlet

System. Management. Automation. applet de commande. ProcessRecord

System. Management. Automation. applet de commande. WriteObject

Déclaration CmdletAttribute

Déclaration ParameterAttribute

Écriture d’une applet de commande Windows PowerShell