Deklaration av attributet Parameter

Attributet Parameter 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 Windows PowerShell användaren om ett parametervärde. Standardvärdet är false.

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

Position (System.Int32) Valfri namngiven parameter. Anger positionen för parametern i ett Windows PowerShell kommando.

ValueFromPipeline (System.Boolean) Valfri namngiven parameter. True anger att cmdlet-parametern tar sitt värde från ett pipeline-objekt. Ange det här nyckelordet om cmdleten kommer åt hela 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 parameter och pipelineobjektet också har en -egenskap, tilldelas värdet för egenskapen Name Name till Name Name parametern 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 Valfri namngiven parameter. Anger en kort beskrivning av parametern. Windows PowerShell här meddelandet när en cmdlet körs och en obligatorisk parameter inte har angetts.

HelpMessageBaseName Valfri namngiven parameter. Anger den plats där resursidentifierare finns. Den här parametern kan till exempel ange en resursgrupp som innehåller hjälpmeddelanden som du vill lokalisera.

HelpMessageResourceId Valfri namngiven parameter. Anger resursidentifieraren för ett hjälpmeddelande.

Kommentarer

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

  • En cmdlet kan ha val av antal parametrar. För en bättre användarupplevelse bör du dock begränsa 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 eller har angetts ValueFromPipeline måste egenskapen ha en offentlig ValueFromPipelineByPropertyName get-åtkomst.

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

  • Om Position nyckelordet inte anges måste cmdlet-parametern refereras till av dess namn.

  • Tänk på 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 det är möjligt. Om cmdleten är avsedd att köras utan parametrar kan den unika parametern inte vara obligatorisk.

    • Ingen parameteruppsättning bö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.

Se även

System.Management.Automation.Parameterattribute

Cmdlet-parameternamn

Skriva en Windows PowerShell-cmdlet