Sdílet prostřednictvím

Deklarace atributu parametru

  • Článek

Atribut Parameter identifikuje veřejnou vlastnost třídy rutiny jako parametr rutiny.

Syntax

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

Parametry

Mandatory (System.Boolean) Volitelný pojmenovaný parametr. True indikuje, že je parametr rutiny povinný. Pokud při vyvolání rutiny není zadaný povinný parametr, Windows PowerShell vyzve uživatele k zadání hodnoty parametru. Výchozí hodnota je false.

ParameterSetName (System.String) Volitelný pojmenovaný parametr. Určuje sadu parametrů, do které tento parametr rutiny patří. Pokud není zadána žádná sada parametrů, parametr patří do všech sad parametrů.

Position (System.Int32) Volitelný pojmenovaný parametr. Určuje pozici parametru v rámci příkazu Windows PowerShellu.

ValueFromPipeline (System.Boolean) Volitelný pojmenovaný parametr. True označuje, že parametr rutiny přebírá jeho hodnotu z objektu kanálu. Toto klíčové slovo zadejte, pokud rutina přistupuje k úplnému objektu, nejen k vlastnosti objektu. Výchozí hodnota je false.

ValueFromPipelineByPropertyName (System.Boolean) Volitelný pojmenovaný parametr. True označuje, že parametr rutiny přebírá jeho hodnotu z vlastnosti objektu kanálu, který má stejný název nebo stejný alias jako tento parametr. Pokud má například rutina parametr Name a objekt kanálu má také vlastnost Name, je hodnota vlastnosti Name přiřazena Name parametru rutiny. Výchozí hodnota je false.

ValueFromRemainingArguments (System.Boolean) Volitelný pojmenovaný parametr. True označuje, že parametr rutiny přijímá všechny zbývající argumenty, které jsou předány rutině. Výchozí hodnota je false.

HelpMessage (System.String) Volitelný pojmenovaný parametr. Určuje krátký popis parametru. Windows PowerShell zobrazí tuto zprávu, když je spuštěna rutina a není zadán povinný parametr.

HelpMessageBaseName (System.String) Volitelný pojmenovaný parametr. Určuje umístění, kde se nacházejí identifikátory prostředků. Tento parametr může například zadat sestavení prostředků obsahující zprávy nápovědy, které chcete lokalizovat.

HelpMessageResourceId (System.String) Volitelný pojmenovaný parametr. Určuje identifikátor prostředku pro zprávu nápovědy.

DontShow (System.Boolean) Volitelný pojmenovaný parametr. True označuje, že parametr je uživateli skrytý pro rozšíření karet a Technologii IntelliSense. Výchozí hodnota je false.

Poznámky

  • Další informace o deklarování tohoto atributu naleznete v tématu Jak deklarovat parametry rutiny.

  • Rutina může mít libovolný počet parametrů. Pro lepší uživatelské prostředí ale omezte počet parametrů.

  • Parametry musí být deklarovány u veřejných nestatického pole nebo vlastností. Parametry by měly být deklarovány u vlastností. Vlastnost musí mít přístupový objekt veřejné sady a pokud je zadáno klíčové slovo ValueFromPipeline nebo ValueFromPipelineByPropertyName, musí mít vlastnost veřejný přístup get.

  • Při zadávání pozičních parametrů omezte počet pozičních parametrů v parametru nastavený na méně než pět. A poziční parametry nemusí být souvislé. Pozice 5, 100 a 250 fungují stejně jako pozice 0, 1 a 2.

  • Pokud není zadané klíčové slovo Position, musí být parametr rutiny odkazován jeho názvem.

  • Při použití sad parametrů si všimněte následujících věcí:

    • Každá sada parametrů musí mít aspoň jeden jedinečný parametr. Dobrý návrh rutiny označuje, že tento jedinečný parametr by měl být také povinný, pokud je to možné. Pokud je vaše rutina navržená tak, aby byla spuštěna bez parametrů, nemůže být jedinečný parametr povinný.

    • Žádná sada parametrů by neměla obsahovat více než jeden poziční parametr se stejnou pozicí.

    • Deklarovat ValueFromPipeline = trueby měl být pouze jeden parametr v sadě parametrů.

    • Více parametrů může definovat ValueFromPipelineByPropertyName = true.

  • Další informace o pokynech pro názvy parametrů naleznete v tématu Názvy parametrů rutin.

  • Atribut parametru je definován System.Management.Automation.ParameterAttribute třída.

  • Parametr DontShow má následující vedlejší účinky:

    • Ovlivňuje všechny sady parametrů přidruženého parametru, i když existuje sada parametrů, ve které DontShow se nepoužívá.
    • Skryje běžné parametry z dokončování tabulátoru a IntelliSense. DontShow neskryje volitelné společné parametry: WhatIf, Confirmnebo UseTransaction.

Viz také