動的パラメーターを宣言する方法

この例では、実行時にコマンドレットに追加される動的パラメーターを定義する方法を示します。 この例では、 Department ユーザーがスイッチパラメーターを指定するたびに、パラメーターがコマンドレットに追加され Employee ます。 動的パラメーターの詳細については、「 コマンドレット動的パラメーター」を参照してください。

動的パラメーターを定義するには

1. コマンドレットのクラス宣言で、 Idynamicparameters インターフェイスを以下のように追加します。

   public class SendGreetingCommand : Cmdlet, IDynamicParameters
   

2. Idynamicparameters *メソッドを呼び出します。このメソッドは、動的パラメーターが定義されているオブジェクトを返します。 この例では、パラメーターを指定したときにメソッドが呼び出され 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;

    // 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;
  }
}

参照

System. Automation. Runtimedefinedparameterdictionary

Idynamicparameters * のようになります。

コマンドレットの動的パラメーター

Windows PowerShell SDK