共用方式為

如何宣告動態參數

此範例示範如何在運行時間定義新增至 Cmdlet 的動態參數。 在此範例中，每當使用者指定 Employee switch 參數時，Department 參數就會新增至 Cmdlet。 如需動態參數的詳細資訊，請參閱 Cmdlet 動態參數。

定義動態參數

  1. 在 Cmdlet 類別宣告中，新增 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. 宣告類別，定義要加入的動態參數。 您可以使用用來宣告靜態 Cmdlet 參數的屬性來宣告動態參數。

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

範例

在此範例中，每當使用者指定 Employee 參數時，就會新增 Department 參數。 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;
  }
}

另請參閱

  • Last updated on