Declaratie van het kenmerk Parameter

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

Syntaxis

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

Parameters

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

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

Position (System.Int32) Optionele benoemde parameter. Hiermee geeft u de positie van de parameter binnen een Windows PowerShell opdracht.

ValueFromPipeline (System.Boolean) Optionele benoemde parameter. True geeft aan dat de cmdlet-parameter de waarde ervan uit een pijplijnobject haalt. 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) Optionele benoemde parameter. True geeft aan dat de cmdlet parameter de waarde van een eigenschap van een pijplijnobject met dezelfde naam of dezelfde alias als deze parameter. Als de cmdlet bijvoorbeeld een parameter heeft en het pijplijnobject ook een eigenschap heeft, wordt de waarde van de eigenschap toegewezen aan de Name Name parameter van de Name Name cmdlet. De standaardwaarde is false.

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

HelpMessage Optionele benoemde parameter. Hiermee geeft u een korte beschrijving van de parameter. Windows PowerShell dit bericht wordt weergegeven wanneer een cmdlet wordt uitgevoerd en er geen verplichte parameter is opgegeven.

HelpMessageBaseName Optionele benoemde parameter. Hiermee geeft u de locatie waar resource-id's zich bevinden. Met deze parameter kan bijvoorbeeld een resource-assembly worden opgegeven die Help-berichten bevat die u wilt lokaliseren.

HelpMessageResourceId Optionele benoemde parameter. Hiermee geeft u de resource-id op voor een Help-bericht.

Opmerkingen

  • Zie How to Declare Cmdlet Parameters (Cmdlet-parametersdeclareeren) voor meer informatie over het declareeren van dit kenmerk.

  • Een cmdlet kan een groot aantal parameters hebben. Voor een betere gebruikerservaring beperkt u echter het aantal parameters.

  • Parameters moeten worden gedeclareerd in openbare niet-statische velden of eigenschappen. Parameters moeten worden gedeclareerd op eigenschappen. De eigenschap moet een openbare set accessoires hebben en als het sleutelwoord of is opgegeven, moet de eigenschap een ValueFromPipeline ValueFromPipelineByPropertyName openbare get-accessoires 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 hoeft niet aaneengesloten te zijn. Posities 5, 100 en 250 werken hetzelfde als posities 0, 1 en 2.

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

  • Let op het volgende wanneer u parametersets gebruikt:

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

    • Geen enkele parameterset mag meer dan één positionele parameter met dezelfde positie bevatten.

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

    • Meerdere parameters kunnen ValueFromPipelineByPropertyName = true definiëren.

  • Zie Cmdlet Parameter Names (Cmdlet-parameternamen) voor meer informatie over de richtlijnen voor parameternamen.

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

Zie ook

System.Management.Automation.Parameterattribute

Parameternamen voor cmdlet

Een Windows PowerShell-cmdlet schrijven