Deklarera cmdlet-parametrar

De här exemplen visar hur du deklarerar namngivna, positionella, obligatoriska, valfria och växelparametrar. 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 attributet Parameter utelämnar Position du nyckelordet från attributet .

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

Mer information om attributet Parameter finns i Deklaration av parameterattribut.

Deklarera en positionsparameter

  • Definiera en offentlig egenskap enligt följande kod. När du lägger till attributet Parameter anger du Position nyckelordet 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 attributet Parameter finns i Deklaration av parameterattribut.

Deklarera en obligatorisk parameter

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

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

Mer information om attributet Parameter finns i Deklaration av parameterattribut.

Deklarera en valfri parameter

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

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

Deklarera en växlingsparameter

  • Definiera en offentlig egenskap som typen System.Management.Automation.SwitchParameteroch deklarera sedan attributet Parameter.

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

Mer information om attributet Parameter finns i Deklaration av parameterattribut.

Deklarera en parameter med alias

  • Definiera en offentlig egenskap enligt följande kod. Lägg till ett aliasattribut som visar en lista över alias 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

Deklaration av attributet Parameter

Deklaration av attributet Alias

Skriva en Windows PowerShell-cmdlet