Deklarování vlastností jako parametrů

Toto téma obsahuje základní informace, které musíte pochopit, než deklarujete parametry rutiny.

Chcete-li deklarovat parametry rutiny v rámci třídy rutiny, definujte veřejné vlastnosti, které představují jednotlivé parametry, a pak ke každé vlastnosti přidejte jeden nebo více atributů parametru. Modul Windows PowerShell runtime používá atributy Parameter k identifikaci vlastnosti jako parametru rutiny. Základní syntaxe pro deklaraci atributu Parameter je [Parameter()] .

Tady je příklad vlastnosti definované jako povinný parametr.

[Parameter(Position = 0, Mandatory = true)]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

Tady je několik věcí, které je dobré si o parametrech zapamatovat.

• Parametr musí být explicitně označen jako veřejný. Parametry, které nejsou označené jako veřejné výchozí pro interní a nebudou nalezeny Windows PowerShell runtime.

• Parametry by měly být definovány jako typy .NET Framework, aby bylo možné zajistit lepší ověřování parametrů. Například parametry, které jsou omezeny na jednu hodnotu ze sady hodnot, by měly být definovány jako typ výčtu. Parametry, které převezměte hodnotu identifikátoru URI (Uniform Resource Identifier), by měly být typu System.Uri.

• Vyhněte se základním parametrům řetězce pro všechny vlastnosti textu s volným formátem, ale bez něj.

• Parametr můžete přidat do libovolného počtu sad parametrů. Další informace o sadách parametrů najdete v tématu Sady parametrů rutiny.

Windows PowerShell také sadu společných parametrů, které jsou automaticky dostupné pro každou rutinu. Další informace o těchto parametrech a jejich aliasech najdete v tématu Běžné parametry rutiny.

Viz také

Běžné parametry rutiny

Typy parametru rutiny

Vytvoření rutiny Windows PowerShellu