Jak deklarovat dynamické parametry

  • Článek

Tento příklad ukazuje, jak definovat dynamické parametry, které se přidávají do rutiny za běhu. V tomto příkladu je Department parametr přidán do rutiny vždy, když uživatel zadá parametr Employee switch. Další informace o dynamických parametrech najdete v tématu Rutina s dynamickými parametry.

Definování dynamických parametrů

  1. V deklaraci třídy rutiny přidejte rozhraní System.Management.Automation.Idynamicparameters, jak je znázorněno níže.

    public class SendGreetingCommand : Cmdlet, IDynamicParameters

  2. Zavolejte metodu System.Management.Automation.Idynamicparameters.Getdynamicparameters*, která vrací objekt, ve kterém jsou definované dynamické parametry. V tomto příkladu je při zadaném parametru Employee volána metoda .

    public object GetDynamicParameters()
{
    if (employee)
    {
      context= new SendGreetingCommandDynamicParameters();
      return context;
    }
    return null;
}
private SendGreetingCommandDynamicParameters context;

  3. Deklarujte třídu, která definuje dynamické parametry, které se mají přidat. K deklaraci dynamických parametrů můžete použít atributy, které jste použili k deklaraci statických parametrů rutiny.

    public class SendGreetingCommandDynamicParameters
{
  [Parameter]
  [ValidateSet ("Marketing", "Sales", "Development")]
  public string Department
  {
    get { return department; }
    set { department = value; }
  }
  private string department;
}

Příklad

V tomto příkladu Department se parametr přidá vždy, když uživatel zadá Employee parametr . Parametr je volitelný parametr a atribut ValidateSet se používá Department k určení povolených argumentů.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Management.Automation;     // PowerShell assembly.

namespace SendGreeting
{
  // Declare the cmdlet class that supports the
  // IDynamicParameters interface.
  [Cmdlet(VerbsCommunications.Send, "Greeting")]
  public class SendGreetingCommand : Cmdlet, IDynamicParameters
  {
    // Declare the parameters for the cmdlet.
    [Parameter(Mandatory = true)]
    public string Name
    {
      get { return name; }
      set { name = value; }
    }
    private string name;

    [Parameter]
    [Alias ("FTE")]
    public SwitchParameter Employee
    {
      get { return employee; }
      set { employee = value; }
    }
    private Boolean employee;

    // Implement GetDynamicParameters to
    // retrieve the dynamic parameter.
    public object GetDynamicParameters()
    {
      if (employee)
      {
        context= new SendGreetingCommandDynamicParameters();
        return context;
      }
      return null;
   }
   private SendGreetingCommandDynamicParameters context;

    // Overide 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 + "! ");
      if (employee)
      {
        WriteObject("Department: " + context.Department);
      }
    }
  }

  // Define the dynamic parameters to be added
  public class SendGreetingCommandDynamicParameters
  {
    [Parameter]
    [ValidateSet ("Marketing", "Sales", "Development")]
    public string Department
    {
      get { return department; }
      set { department = value; }
    }
    private string department;
  }
}

Viz také

System.Management.Automation.Runtimedefinedparameterdictionary

System.Management.Automation.Idynamicparameters.Getdynamicparameters*

Dynamické parametry rutin

Sada SDK Windows PowerShellu