Jak deklarovat parametry Cmdletu

Tyto příklady ukazují, jak deklarovat pojmenované, poziční, povinné, volitelné a [switch] parametry. Tyto příklady také ukazují, jak definovat alias parametru.

Jak deklarovat pojmenovaný parametr

• Definujte veřejnou vlastnost, jak je znázorněno v následujícím kódu. Když přidáte atribut Parameter, vynecháte Position klíčové slovo z atributu.

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

Další informace o atributu Parametr naleznete v tématu Deklarace atributu parametru.

Jak deklarovat poziční parametr

• Definujte veřejnou vlastnost, jak je znázorněno v následujícím kódu. Když přidáte atribut Parameter, nastavte Position klíčové slovo na pozici argumentu. Hodnota 0 označuje první pozici.

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

Další informace o atributu Parametr naleznete v tématu Deklarace atributu parametru.

Jak deklarovat povinný parametr

• Definujte veřejnou vlastnost, jak je znázorněno v následujícím kódu. Když přidáte atribut Parameter, nastavte Mandatory klíčové slovo na true.

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

Další informace o atributu Parametr naleznete v tématu Deklarace atributu parametru.

Deklarace volitelného parametru

• Definujte veřejnou vlastnost, jak je znázorněno v následujícím kódu. Když přidáte atribut Parameter, vynecháte Mandatory klíčové slovo.

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

Jak deklarovat [switch] parametr

• Definujte veřejnou vlastnost jako typ System.Management.Automation.SwitchParameter a deklarujte atribut Parametr.

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

Další informace o atributu Parametr naleznete v tématu Deklarace atributu parametru.

Jak deklarovat parametr s aliasy

• Definujte veřejnou vlastnost, jak je znázorněno v následujícím kódu. Přidejte atribut Alias, který obsahuje aliasy pro parametr. V tomto příkladu jsou pro stejný parametr definovány tři aliasy. První alias poskytuje zástupce. Druhý a třetí aliasy poskytují názvy, které můžete použít pro různé scénáře.

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

Další informace o atributu Alias naleznete v tématu Deklarace atributu Alias.

Viz také

System.Management.Automation.SwitchParameter

Deklarace atributu parametru

Deklarace atributu aliasu

Popis rutiny PowerShellu Windows