Delen via

Dynamische parameters declareren

In dit voorbeeld ziet u hoe u dynamische parameters definieert die tijdens runtime worden toegevoegd aan de cmdlet. In dit voorbeeld wordt de parameter Department toegevoegd aan de cmdlet wanneer de gebruiker de parameter Employee switch opgeeft. Zie Cmdlet Dynamic Parametersvoor meer informatie over dynamische parameters.

Dynamische parameters definiëren

  1. Voeg in de declaratie van de cmdlet-klasse de System.Management.Automation.IDynamicParameters interface toe, zoals wordt weergegeven.

    public class SendGreetingCommand : Cmdlet, IDynamicParameters

  2. Roep de System.Management.Automation.IDynamicParameters.GetDynamicParameters* methode aan, waarmee het object wordt geretourneerd waarin de dynamische parameters zijn gedefinieerd. In dit voorbeeld wordt de methode aangeroepen wanneer de parameter Employee is opgegeven.

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

  3. Declareer een klasse die de dynamische parameters definieert die moeten worden toegevoegd. U kunt de kenmerken gebruiken die u hebt gebruikt om de parameters van de statische cmdlet te declareren om de dynamische parameters te declareren.

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

Voorbeeld

In dit voorbeeld wordt de parameter Department toegevoegd wanneer de gebruiker de parameter Employee opgeeft. De parameter Department is een optionele parameter en het kenmerk ValidateSet wordt gebruikt om de toegestane argumenten op te geven.

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

Zie ook

  • Last updated on