Delen via

Declaratie van parameterkenmerk

  • Artikel

Het kenmerk Parameter identificeert een openbare eigenschap van de cmdlet-klasse als een cmdlet-parameter.

Syntaxis

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

Parameters

Mandatory (System.Boolean) Optioneel benoemde parameter. True geeft aan dat de cmdlet-parameter is vereist. Als er geen vereiste parameter wordt opgegeven wanneer de cmdlet wordt aangeroepen, vraagt Windows PowerShell de gebruiker om een parameterwaarde. De standaardwaarde is false.

ParameterSetName (System.String) Optioneel benoemde parameter. Hiermee geeft u de parameterset waartoe deze cmdlet-parameter behoort. Als er geen parameterset is opgegeven, behoort de parameter tot alle parametersets.

Position (System.Int32) Optioneel benoemde parameter. Hiermee geeft u de positie van de parameter in een Windows PowerShell-opdracht.

ValueFromPipeline (System.Boolean) Optioneel benoemde parameter. True geeft aan dat de cmdlet-parameter de waarde van een pijplijnobject opneemt. Geef dit trefwoord op als de cmdlet toegang heeft tot het volledige object, niet alleen een eigenschap van het object. De standaardwaarde is false.

ValueFromPipelineByPropertyName (System.Boolean) Optioneel benoemde parameter. True geeft aan dat de cmdlet-parameter de waarde haalt uit een eigenschap van een pijplijnobject met dezelfde naam of dezelfde alias als deze parameter. Als de cmdlet bijvoorbeeld een Name parameter heeft en het pijplijnobject ook een eigenschap Name heeft, wordt de waarde van de eigenschap Name toegewezen aan de parameter Name van de cmdlet. De standaardwaarde is false.

ValueFromRemainingArguments (System.Boolean) Optioneel benoemde parameter. True geeft aan dat de cmdlet-parameter alle resterende argumenten accepteert die worden doorgegeven aan de cmdlet. De standaardwaarde is false.

HelpMessage (System.String) Optioneel benoemde parameter. Hiermee geeft u een korte beschrijving van de parameter. In Windows PowerShell wordt dit bericht weergegeven wanneer een cmdlet wordt uitgevoerd en er geen verplichte parameter is opgegeven.

HelpMessageBaseName (System.String) Optioneel benoemde parameter. Hiermee geeft u de locatie op waar resource-id's zich bevinden. Met deze parameter kunt u bijvoorbeeld een resourceassembly opgeven die Help-berichten bevat die u wilt lokaliseren.

HelpMessageResourceId (System.String) Optioneel benoemde parameter. Hiermee geeft u de resource-id voor een Help-bericht.

DontShow (System.Boolean) Optioneel benoemde parameter. True geeft aan dat de parameter is verborgen voor de gebruiker voor tabuitbreiding en IntelliSense. De standaardwaarde is false.

Opmerkingen

  • Zie Cmdlet-parameters declarerenvoor meer informatie over het declareren van dit kenmerk.

  • Een cmdlet kan een willekeurig aantal parameters hebben. Beperk echter het aantal parameters voor een betere gebruikerservaring.

  • Parameters moeten worden gedeclareerd voor openbare niet-statische velden of eigenschappen. Parameters moeten worden gedeclareerd voor eigenschappen. De eigenschap moet een openbare toegangsfunctie hebben en als het trefwoord ValueFromPipeline of ValueFromPipelineByPropertyName is opgegeven, moet de eigenschap een openbare get-accessor hebben.

  • Wanneer u positionele parameters opgeeft, beperkt u het aantal positionele parameters in een parameter die is ingesteld op minder dan vijf. En positionele parameters hoeven niet aaneengesloten te zijn. Posities 5, 100 en 250 werken hetzelfde als posities 0, 1 en 2.

  • Wanneer het trefwoord Position niet is opgegeven, moet naar de cmdlet-parameter worden verwezen met de naam.

  • Wanneer u parametersets gebruikt, moet u rekening houden met het volgende:

    • Elke parameterset moet ten minste één unieke parameter hebben. Goed cmdlet-ontwerp geeft aan dat deze unieke parameter ook verplicht moet zijn indien mogelijk. Als uw cmdlet is ontworpen om zonder parameters te worden uitgevoerd, kan de unieke parameter niet verplicht zijn.

    • Er mag geen parameterset meer dan één positionele parameter met dezelfde positie bevatten.

    • Slechts één parameter in een parameterset moet ValueFromPipeline = truedeclareren.

    • Meerdere parameters kunnen ValueFromPipelineByPropertyName = truedefiniëren.

  • Zie Cmdlet Parameter Namesvoor meer informatie over de richtlijnen voor parameternamen.

  • Het parameterkenmerk wordt gedefinieerd door de klasse System.Management.Automation.ParameterAttribute.

  • De parameter DontShow heeft de volgende bijwerkingen:

    • Is van invloed op alle parametersets voor de bijbehorende parameter, zelfs als er een parameterset is waarin DontShow niet wordt gebruikt.
    • Hiermee worden algemene parameters verborgen voor het voltooien van tabbladen en IntelliSense. DontShow verbergt de optionele algemene parameters niet: WhatIf-, bevestigenof UseTransaction-.

Zie ook