Cmdlet-parameters declareren

Deze voorbeelden laten zien hoe u benoemde, positionele, vereiste, optionele en switchparameters declareer. Deze voorbeelden laten ook zien hoe u een parameteralias definieert.

Een benoemde parameter declareer

• Definieer een openbare eigenschap zoals wordt weergegeven in de volgende code. Wanneer u het kenmerk Parameter 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 kenmerk Parameter.

Een positionele parameter declareer

• Definieer een openbare eigenschap zoals wordt weergegeven in de volgende code. Wanneer u het kenmerk Parameter 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 kenmerk Parameter.

Een verplichte parameter declareer

• Definieer een openbare eigenschap zoals wordt weergegeven in de volgende code. Wanneer u het kenmerk Parameter 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 kenmerk Parameter.

Een optionele parameter declareer

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

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

Een switchparameter declareer

• Definieer een openbare eigenschap als het type System.Management.Automation.SwitchParameteren 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 kenmerk Parameter.

Een parameter declareer met aliassen

• Definieer een openbare eigenschap zoals wordt weergegeven in de volgende code. Voeg een aliaskenmerk toe dat de aliassen voor de parameter vermeldt. 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 Declaratie van aliaskenmerken voor meer informatie over het kenmerk Alias.

Zie ook

System.Management.Automation.SwitchParameter

Declaratie van het kenmerk Parameter

Declaratie van het kenmerk Alias

Een Windows PowerShell-cmdlet schrijven