Как объявить динамические параметры

В этом примере показано, как определить динамические параметры, добавляемые в командлет во время выполнения. В этом примере параметр Department добавляется в командлет всякий раз, когда пользователь задает параметр коммутатора Employee. Дополнительные сведения о динамических параметрах см. в динамических параметров командлета.

Определение динамических параметров

1. В объявлении класса командлета добавьте интерфейс System.Management.Automation.IDynamicParameters, как показано ниже.

   public class SendGreetingCommand : Cmdlet, IDynamicParameters
   

2. Вызовите метод System.Management.Automation.IDynamicParameters.GetDynamicParameters*, который возвращает объект, в котором определены динамические параметры. В этом примере метод вызывается при указании параметра Employee.

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

3. Объявите класс, определяющий добавляемые динамические параметры. Атрибуты, используемые для объявления статических параметров командлета, можно использовать для объявления динамических параметров.

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

Пример

В этом примере параметр Department добавляется всякий раз, когда пользователь задает параметр Employee. Параметр Department является необязательным параметром, а атрибут ValidateSet используется для указания допустимых аргументов.

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;

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

См. также

• System.Management.Automation.RuntimeDefinedParameterDictionary
• System.Management.Automation.IDynamicParameters.GetDynamicParameters*
• динамических параметров командлета
• пакета SDK для Windows PowerShell