Parameter, deklaracja atrybutu

  • Artykuł

Atrybut Parameter identyfikuje właściwość publiczną klasy polecenia cmdlet jako parametr polecenia cmdlet.

Składnia

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

Parametry

Mandatory(System.Boolean) Opcjonalny nazwany parametr. True wskazuje, że parametr polecenia cmdlet jest wymagany. Jeśli podczas wywoływania polecenia cmdlet nie podano wymaganego parametru, Windows PowerShell monituje użytkownika o wartość parametru. Wartość domyślna to false.

ParameterSetName(System.String) Opcjonalny nazwany parametr. Określa zestaw parametrów, do którego należy ten parametr polecenia cmdlet. Jeśli nie określono zestawu parametrów, parametr należy do wszystkich zestawów parametrów.

Position(System.Int32) Opcjonalny nazwany parametr. Określa pozycję parametru w Windows PowerShell polecenia.

ValueFromPipeline(System.Boolean) Opcjonalny nazwany parametr. True wskazuje, że parametr polecenia cmdlet pobiera jego wartość z obiektu potoku. Określ to słowo kluczowe, jeśli polecenie cmdlet uzyskuje dostęp do kompletnego obiektu, a nie tylko do właściwości obiektu . Wartość domyślna to false.

ValueFromPipelineByPropertyName(System.Boolean) Opcjonalny nazwany parametr. True wskazuje, że parametr polecenia cmdlet pobiera swoją wartość z właściwości obiektu potoku o takiej samej nazwie lub tym samym aliasie co ten parametr. Jeśli na przykład polecenie cmdlet ma parametr, a obiekt potoku ma również właściwość , wartość właściwości jest przypisywana do parametru Name Name polecenia Name Name cmdlet . Wartość domyślna to false.

ValueFromRemainingArguments(System.Boolean) Opcjonalny nazwany parametr. True wskazuje, że parametr polecenia cmdlet akceptuje wszystkie pozostałe argumenty przekazywane do polecenia cmdlet. Wartość domyślna to false.

HelpMessage Opcjonalny nazwany parametr. Określa krótki opis parametru. Windows PowerShell wyświetla ten komunikat, gdy polecenie cmdlet jest uruchamiane i nie określono obowiązkowego parametru.

HelpMessageBaseName Opcjonalny nazwany parametr. Określa lokalizację, w której znajdują się identyfikatory zasobów. Na przykład ten parametr może określać zestaw zasobów zawierający komunikaty Pomocy, które mają być zlokalizowane.

HelpMessageResourceId Opcjonalny nazwany parametr. Określa identyfikator zasobu dla komunikatu Pomocy.

Uwagi

  • Aby uzyskać więcej informacji na temat deklarowania tego atrybutu, zobacz How to Declare Cmdlet Parameters (Jak zadeklarować parametry polecenia cmdlet).

  • Polecenie cmdlet może mieć dowolną liczbę parametrów. Jednak aby poprawić środowisko użytkownika, ogranicz liczbę parametrów.

  • Parametry muszą być zadeklarowane w publicznych niestatycznych polach lub właściwościach. Parametry powinny być deklarowane we właściwościach. Właściwość musi mieć publiczny zestaw dostępu, a jeśli określono słowo kluczowe lub , właściwość musi mieć publiczną ValueFromPipeline ValueFromPipelineByPropertyName get accessor.

  • Określając parametry pozyacyjne, należy ograniczyć liczbę parametrów pozysowych w parametrze ustawionym na mniej niż pięć. Parametry pozyacyjne nie muszą być ciągłe. Pozycje 5, 100 i 250 działają tak samo jak pozycje 0, 1 i 2.

  • Jeśli słowo Position kluczowe nie jest określone, parametr polecenia cmdlet musi być przywołyny przez jego nazwę.

  • W przypadku używania zestawów parametrów należy pamiętać o następujących następujących ustawieniach:

    • Każdy zestaw parametrów musi mieć co najmniej jeden unikatowy parametr. Dobry projekt polecenia cmdlet wskazuje, że ten unikatowy parametr również powinien być obowiązkowy, jeśli to możliwe. Jeśli polecenie cmdlet zostało zaprojektowane do uruchamiania bez parametrów, unikatowy parametr nie może być obowiązkowy.

    • Żaden zestaw parametrów nie powinien zawierać więcej niż jednego parametru pozysłowego o tej samej pozycji.

    • Tylko jeden parametr w zestawie parametrów powinien deklarować ValueFromPipeline = true wartość .

    • Wiele parametrów może definiować ValueFromPipelineByPropertyName = true .

  • Aby uzyskać więcej informacji na temat wytycznych dotyczących nazw parametrów, zobacz Nazwy parametrów polecenia cmdlet.

  • Atrybut parametru jest definiowany przez klasę System.Management.Automation.Parameterattribute.

Zobacz też

System.Management.Automation.Parameterattribute

Nazwy parametrów polecenia cmdlet

Pisanie polecenia cmdlet programu Windows PowerShell