Dela via

Parameterattributdeklaration

  • Artikel

Parameterattributet identifierar en offentlig egenskap för cmdlet-klassen som en cmdlet-parameter.

Syntax

[Parameter()]
[Parameter(Named Parameters...)]

Parametrar

Mandatory (System.Boolean) Valfri namngiven parameter. True anger att cmdlet-parametern krävs. Om en obligatorisk parameter inte anges när cmdleten anropas uppmanar Windows PowerShell användaren att ange ett parametervärde. Standardvärdet är false.

ParameterSetName (System.String) Valfri namngiven parameter. Anger parameteruppsättningen som den här cmdlet-parametern tillhör. Om ingen parameteruppsättning har angetts tillhör parametern alla parameteruppsättningar.

Position (System.Int32) Valfri med namnet parameter. Anger parameterns position i ett Windows PowerShell-kommando.

ValueFromPipeline (System.Boolean) Valfri namngiven parameter. True anger att cmdlet-parametern tar värdet från ett pipelineobjekt. Ange det här nyckelordet om cmdleten kommer åt det fullständiga objektet, inte bara en egenskap för objektet. Standardvärdet är false.

ValueFromPipelineByPropertyName (System.Boolean) Valfri namngiven parameter. True anger att cmdlet-parametern tar sitt värde från en egenskap för ett pipelineobjekt som har antingen samma namn eller samma alias som den här parametern. Om cmdleten till exempel har en Name-parameter och pipelineobjektet också har en Name-egenskap tilldelas värdet för egenskapen Name till parametern Name för cmdleten. Standardvärdet är false.

ValueFromRemainingArguments (System.Boolean) Valfri namngiven parameter. True anger att cmdlet-parametern accepterar alla återstående argument som skickas till cmdleten. Standardvärdet är false.

HelpMessage (System.String) Valfri namngiven parameter. Anger en kort beskrivning av parametern. Windows PowerShell visar det här meddelandet när en cmdlet körs och en obligatorisk parameter inte har angetts.

HelpMessageBaseName (System.String) Valfri namngiven parameter. Anger platsen där resursidentifierare finns. Den här parametern kan till exempel ange en resurssammansättning som innehåller hjälpmeddelanden som du vill lokalisera.

HelpMessageResourceId (System.String) Valfri namngiven parameter. Anger resursidentifieraren för ett hjälpmeddelande.

DontShow (System.Boolean) Valfri namngiven parameter. True anger att parametern är dold för användaren för flikexpansion och IntelliSense. Standardvärdet är false.

Anmärkningar

  • Mer information om hur du deklarerar det här attributet finns i Deklarera cmdletparametrar.

  • En cmdlet kan ha valfritt antal parametrar. För en bättre användarupplevelse begränsar du dock antalet parametrar.

  • Parametrar måste deklareras för offentliga icke-statiska fält eller egenskaper. Parametrar ska deklareras för egenskaper. Egenskapen måste ha en offentlig uppsättningsåtkomst och om nyckelordet ValueFromPipeline eller ValueFromPipelineByPropertyName anges måste egenskapen ha en offentlig get-accessor.

  • När du anger positionsparametrar begränsar du antalet positionsparametrar i en parameter som är inställd på mindre än fem. Och positionsparametrar behöver inte vara sammanhängande. Positionerna 5, 100 och 250 fungerar på samma sätt som positionerna 0, 1 och 2.

  • När nyckelordet Position inte anges måste cmdlet-parametern refereras till med dess namn.

  • Observera följande när du använder parameteruppsättningar:

    • Varje parameteruppsättning måste ha minst en unik parameter. Bra cmdlet-design anger att den här unika parametern också bör vara obligatorisk om möjligt. Om cmdleten är utformad för att köras utan parametrar kan den unika parametern inte vara obligatorisk.

    • Ingen parameteruppsättning får innehålla mer än en positionsparameter med samma position.

    • Endast en parameter i en parameteruppsättning ska deklarera ValueFromPipeline = true.

    • Flera parametrar kan definiera ValueFromPipelineByPropertyName = true.

  • Mer information om riktlinjerna för parameternamn finns i Cmdlet-parameternamn.

  • Parameterattributet definieras av klassen System.Management.Automation.ParameterAttribute.

  • Parametern DontShow har följande biverkningar:

    • Påverkar alla parameteruppsättningar för den associerade parametern, även om det finns en parameteruppsättning där DontShow inte används.
    • Döljer vanliga parametrar från tabbavslut och IntelliSense. DontShow döljer inte de valfria vanliga parametrarna: WhatIf, Confirmeller UseTransaction.

Se även