Hur man deklarerar cmdletparametrar

De här exemplen visar hur du deklarerar namngivna, positionella, obligatoriska, valfria och [switch] parametrar. De här exemplen visar också hur du definierar ett parameteralias.

Deklarera en namngiven parameter

• Definiera en offentlig egenskap enligt följande kod. När du lägger till parameterattributet utelämnar du nyckelordet Position från attributet.

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

Mer information om parameterattributet finns i Parameterattributdeklaration.

Deklarera en positionsparameter

• Definiera en offentlig egenskap enligt följande kod. När du lägger till parameterattributet anger du nyckelordet Position till argumentpositionen. Värdet 0 anger den första positionen.

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

Mer information om parameterattributet finns i Parameterattributdeklaration.

Deklarera en obligatorisk parameter

• Definiera en offentlig egenskap enligt följande kod. När du lägger till parameterattributet anger du nyckelordet Mandatory till true.

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

Mer information om parameterattributet finns i Parameterattributdeklaration.

Deklarera en valfri parameter

• Definiera en offentlig egenskap enligt följande kod. När du lägger till parameterattributet utelämnar du nyckelordet Mandatory .

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

Deklarera en [switch] parameter

• Definiera en offentlig egenskap som typen System.Management.Automation.SwitchParameter och deklarera sedan parameterattributet.

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

Mer information om parameterattributet finns i Parameterattributdeklaration.

Deklarera en parameter med alias

• Definiera en offentlig egenskap enligt följande kod. Lägg till ett aliasattribut som visar aliasen för parametern. I det här exemplet definieras tre alias för samma parameter. Det första aliaset innehåller en genväg. Det andra och tredje aliaset innehåller namn som du kan använda för olika scenarier.

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

Mer information om aliasattributet finns i Deklaration av aliasattribut.

Se även

System.Management.Automation.SwitchParameter

Parameterattributdeklaration

Deklaration av aliasattribut

Skriva en Windows PowerShell-cmdlet