Parancsmag írásaHow to write a cmdlet

Ez a cikk a parancsmagok írását mutatja be.This article shows how to write a cmdlet. A Send-Greeting parancsmag egyetlen felhasználónevet fogad el bemenetként, majd egy üdvözlést ír a felhasználónak.The Send-Greeting cmdlet takes a single user name as input and then writes a greeting to that user. Bár a parancsmag nem sokat működik, ez a példa egy parancsmag fő részeit mutatja be.Although the cmdlet does not do much work, this example demonstrates the major sections of a cmdlet.

A parancsmag írásához szükséges lépésekSteps to write a cmdlet

  1. Ha az osztályt parancsmagként szeretné deklarálni, használja a parancsmag attribútumot.To declare the class as a cmdlet, use the Cmdlet attribute. A parancsmag attribútum a parancsmag nevéhez tartozó műveletet és főnévi nevet adja meg.The Cmdlet attribute specifies the verb and the noun for the cmdlet name.

    További információ a parancsmag attribútumról: CmdletAttribute deklaráció.For more information about the Cmdlet attribute, see CmdletAttribute Declaration.

  2. Adja meg az osztály nevét.Specify the name of the class.

  3. Azt határozza meg, hogy a parancsmag a következő osztályok valamelyikéről származik:Specify that the cmdlet derives from either of the following classes:

  4. A parancsmag paramétereinek megadásához használja a Parameters attribútumot .To define the parameters for the cmdlet, use the Parameter attribute. Ebben az esetben csak egy kötelező paraméter van megadva.In this case, only one required parameter is specified.

    További információ a paraméter attribútumáról: ParameterAttribute deklaráció.For more information about the Parameter attribute, see ParameterAttribute Declaration.

  5. Bírálja felül a bemeneti feldolgozási módszert, amely feldolgozza a bemenetet.Override the input processing method that processes the input. Ebben az esetben a System. Management. Automation. parancsmag. ProcessRecord metódus felülbírálva van.In this case, the System.Management.Automation.Cmdlet.ProcessRecord method is overridden.

  6. Az üdvözlés írásához használja a System. Management. Automation. parancsmag. WriteObjectmetódust.To write the greeting, use the method System.Management.Automation.Cmdlet.WriteObject. A köszöntés a következő formátumban jelenik meg:The greeting is displayed in the following format:

    Hello <UserName>!
    

PéldaExample

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 + "!");
    }
  }
}

Lásd mégSee also

System. Management. Automation. parancsmagSystem.Management.Automation.Cmdlet

System. Management. Automation. PSCmdletSystem.Management.Automation.PSCmdlet

System. Management. Automation. parancsmag. ProcessRecordSystem.Management.Automation.Cmdlet.ProcessRecord

System. Management. Automation. parancsmag. WriteObjectSystem.Management.Automation.Cmdlet.WriteObject

CmdletAttribute nyilatkozatCmdletAttribute Declaration

ParameterAttribute nyilatkozatParameterAttribute Declaration

Windows PowerShell-parancsmag írásaWriting a Windows PowerShell Cmdlet