Hoe Cmdlet-parameters te declareren

Deze voorbeelden laten zien hoe u benoemde, positionele, vereiste, optionele en [switch] parameters declareert. Deze voorbeelden laten ook zien hoe u een parameteralias definieert.

Een benoemde parameter declareren

• Definieer een openbare eigenschap, zoals wordt weergegeven in de volgende code. Wanneer u het parameterkenmerk toevoegt, laat u het Position trefwoord weg uit het kenmerk.

  [Parameter()]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Zie parameterkenmerkdeclaratie voor meer informatie over het parameterkenmerk.

Een positionele parameter declareren

• Definieer een openbare eigenschap, zoals wordt weergegeven in de volgende code. Wanneer u het parameterkenmerk toevoegt, stelt u het Position trefwoord in op de argumentpositie. Een waarde van 0 geeft de eerste positie aan.

  [Parameter(Position = 0)]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Zie parameterkenmerkdeclaratie voor meer informatie over het parameterkenmerk.

Een verplichte parameter declareren

• Definieer een openbare eigenschap, zoals wordt weergegeven in de volgende code. Wanneer u het parameterkenmerk toevoegt, stelt u het Mandatory trefwoord in op true.

  [Parameter(Position = 0, Mandatory = true)]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Zie parameterkenmerkdeclaratie voor meer informatie over het parameterkenmerk.

Een optionele parameter declareren

• Definieer een openbare eigenschap, zoals wordt weergegeven in de volgende code. Wanneer u het parameterkenmerk toevoegt, laat u het Mandatory trefwoord weg.

  [Parameter(Position = 0)]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Een parameter declareren [switch]

• Definieer een openbare eigenschap als type System.Management.Automation.SwitchParameter en declareer vervolgens het kenmerk Parameter.

  [Parameter(Position = 1)]
  public SwitchParameter GoodBye
  {
    get { return goodbye; }
    set { goodbye = value; }
  }
  private bool goodbye;
  

Zie parameterkenmerkdeclaratie voor meer informatie over het parameterkenmerk.

Een parameter declareren met aliassen

• Definieer een openbare eigenschap, zoals wordt weergegeven in de volgende code. Voeg een aliaskenmerk toe met de aliassen voor de parameter. In dit voorbeeld worden drie aliassen gedefinieerd voor dezelfde parameter. De eerste alias biedt een snelkoppeling. De tweede en derde aliassen bieden namen die u voor verschillende scenario's kunt gebruiken.

  [Alias("UN","Writer","Editor")]
  [Parameter()]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Zie De declaratie van aliaskenmerken voor meer informatie over het aliaskenmerk.

Zie ook

System.Management.Automation.SwitchParameter

Declaratie van parameterkenmerk

Declaratie van aliaskenmerk

Een Windows PowerShell-cmdlet schrijven