Udostępnij za pośrednictwem

Deklaracja atrybutu parametru

  • Artykuł

Atrybut Parametr identyfikuje publiczną właściwość klasy 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 wymagany parametr nie zostanie podany po wywołaniu polecenia cmdlet, program Windows PowerShell wyświetli użytkownikowi monit o podanie wartości 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 żadnego zestawu parametrów, parametr należy do wszystkich zestawów parametrów.

Position (System.Int32) Opcjonalny nazwany parametr. Określa położenie parametru w poleceniu programu Windows PowerShell.

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

ValueFromPipelineByPropertyName (System.Boolean) Opcjonalny nazwany parametr. True wskazuje, że parametr cmdlet przyjmuje jego wartość z właściwości obiektu potoku, który ma taką samą nazwę lub ten sam alias co ten parametr. Jeśli na przykład polecenie cmdlet ma parametr Name, a obiekt potoku ma również właściwość Name, wartość właściwości Name jest przypisywana do parametru Name polecenia cmdlet. Wartość domyślna to false.

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

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

HelpMessageBaseName (System.String) 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 chcesz zlokalizować.

HelpMessageResourceId (System.String) Opcjonalny nazwany parametr. Określa identyfikator zasobu dla komunikatu Pomocy.

DontShow (System.Boolean) Opcjonalny nazwany parametr. True wskazuje, że parametr jest ukryty dla użytkownika w celu rozszerzenia karty i funkcji IntelliSense. Wartość domyślna to false.

Uwagi

  • Aby uzyskać więcej informacji na temat deklarowania tego atrybutu, zobacz Jak zadeklarować parametry polecenia cmdlet.

  • Polecenie cmdlet może mieć dowolną liczbę parametrów. Jednak w celu uzyskania lepszego środowiska użytkownika ogranicz liczbę parametrów.

  • Parametry muszą być deklarowane w publicznych polach lub właściwościach niestacjonanych. Parametry należy zadeklarować we właściwościach. Właściwość musi mieć metodę dostępu zestawu publicznego, a jeśli określono słowo kluczowe ValueFromPipeline lub ValueFromPipelineByPropertyName, właściwość musi mieć publiczny dostęp dostępu.

  • Po określeniu parametrów pozycyjnych ogranicz liczbę parametrów pozycyjnych w parametrze ustawionym na mniej niż pięć. Parametry pozycyjne nie muszą być ciągłe. Stanowiska 5, 100 i 250 działają tak samo jak pozycje 0, 1 i 2.

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

  • W przypadku używania zestawów parametrów należy zwrócić uwagę na następujące kwestie:

    • Każdy zestaw parametrów musi mieć co najmniej jeden unikatowy parametr. Dobry projekt polecenia cmdlet wskazuje, że ten unikatowy parametr powinien być również obowiązkowy, jeśli to możliwe. Jeśli polecenie cmdlet jest przeznaczone 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 pozycyjnego o tej samej pozycji.

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

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

  • Aby uzyskać więcej informacji na temat wytycznych dotyczących nazw parametrów, zobacz Cmdlet Parameter Names.

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

  • Parametr DontShow ma następujące skutki uboczne:

    • Wpływa na wszystkie zestawy parametrów skojarzonego parametru, nawet jeśli istnieje zestaw parametrów, w którym DontShow jest nieużywany.
    • Ukrywa typowe parametry przed ukończeniem karty i funkcją IntelliSense. DontShow nie ukrywa opcjonalnych typowych parametrów: WhatIf, Potwierdźlub UseTransaction.

Zobacz też