Deklarace atributu Parameter

  • Článek

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

Syntaxe

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

Parametry

Mandatory (System. Boolean) volitelný pojmenovaný parametr. True Určuje, že parametr rutiny je povinný. pokud při vyvolání rutiny není zadán požadovaný parametr, Windows PowerShell vyzve uživatele k zadání hodnoty parametru. Výchozí formát 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 Windows PowerShell příkazu.

ValueFromPipeline (System. Boolean) volitelný pojmenovaný parametr. True označuje, že parametr rutiny přebírá svou hodnotu z objektu kanálu. Toto klíčové slovo zadejte, pokud rutina přistupuje k kompletnímu objektu, nikoli pouze k vlastnosti objektu. Výchozí formát je false.

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

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

HelpMessage Volitelný pojmenovaný parametr. Určuje krátký popis parametru. Windows PowerShell zobrazí tuto zprávu, když se spustí rutina a není zadaný povinný parametr.

HelpMessageBaseName Volitelný pojmenovaný parametr. Určuje umístění, kde se nacházejí identifikátory prostředků. Tento parametr například může určovat sestavení prostředků, které obsahuje zprávy s nápovědu, které chcete lokalizovat.

HelpMessageResourceId Volitelný pojmenovaný parametr. Určuje identifikátor prostředku pro zprávu s nápovědu.

Poznámky

  • Další informace o tom, jak deklarovat tento atribut, naleznete v tématu How to Declare Parameters rutines.

  • 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ých polí nebo vlastností. Parametry by měly být deklarovány u vlastností. Vlastnost musí mít přistupující objekt veřejné sady a pokud ValueFromPipeline ValueFromPipelineByPropertyName je zadané klíčové slovo nebo, vlastnost musí mít veřejný přistupující objekt get.

  • Když určíte poziční parametry, omezte počet pozičních parametrů v parametru nastaveného 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 Position klíčové slovo není zadáno, parametr rutiny musí být odkazován podle jeho názvu.

  • Pokud používáte sady parametrů, vezměte na vědomí následující:

    • Každá sada parametrů musí mít alespoň jeden jedinečný parametr. Dobrý návrh rutiny indikuje, ž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 běžela bez parametrů, jedinečný parametr nemůže být povinný.

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

    • Deklarovat se dá jenom jeden parametr v sadě parametrů ValueFromPipeline = true .

    • Lze definovat více parametrů ValueFromPipelineByPropertyName = true .

  • Další informace o pokynech pro názvy parametrů najdete v tématu názvy parametrů rutiny.

  • Atribut Parameter je definován třídou System. Management. Automation. ParameterAttribute .

Viz také

System. Management. Automation. ParameterAttribute

Názvy parametrů rutiny

Vytvoření rutiny Windows PowerShellu