Parameter, deklaracja atrybutuParameter Attribute Declaration

Atrybut Parameter określa publiczną właściwość klasy poleceń cmdlet jako parametr polecenia cmdlet.The Parameter attribute identifies a public property of the cmdlet class as a cmdlet parameter.

SkładniaSyntax

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

ParametryParameters

Mandatory (System. Boolean) opcjonalny nazwany parametr.Mandatory (System.Boolean) Optional named parameter. True wskazuje, że parametr polecenia cmdlet jest wymagany.True indicates the cmdlet parameter is required. Jeśli nie podano wymaganego parametru, gdy polecenie cmdlet zostanie wywołane, program Windows PowerShell poprosi użytkownika o wartość parametru.If a required parameter is not provided when the cmdlet is invoked, Windows PowerShell prompts the user for a parameter value. Wartość domyślna to false.The default is false.

ParameterSetName (System. String) opcjonalny nazwany parametr.ParameterSetName (System.String) Optional named parameter. Określa zestaw parametrów, do których należy ten parametr polecenia cmdlet.Specifies the parameter set that this cmdlet parameter belongs to. Jeśli nie określono żadnego zestawu parametrów, parametr należy do wszystkich zestawów parametrów.If no parameter set is specified, the parameter belongs to all parameter sets.

Position (System. Int32) opcjonalny nazwany parametr.Position (System.Int32) Optional named parameter. Określa pozycję parametru w poleceniu programu Windows PowerShell.Specifies the position of the parameter within a Windows PowerShell command.

ValueFromPipeline (System. Boolean) opcjonalny nazwany parametr.ValueFromPipeline (System.Boolean) Optional named parameter. True wskazuje, że parametr polecenia cmdlet pobiera swoją wartość z obiektu potoku.True indicates that the cmdlet parameter takes its value from a pipeline object. 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.Specify this keyword if the cmdlet accesses the complete object, not just a property of the object. Wartość domyślna to false.The default is false.

ValueFromPipelineByPropertyName (System. Boolean) opcjonalny nazwany parametr.ValueFromPipelineByPropertyName (System.Boolean) Optional named parameter. True wskazuje, że parametr cmdlet pobiera swoją wartość z właściwości obiektu potoku, który ma taką samą nazwę, jak ten parametr.True indicates that the cmdlet parameter takes its value from a property of a pipeline object that has either the same name or the same alias as this parameter. Na przykład jeśli polecenie cmdlet ma Name parametr, a obiekt potoku również ma Name Właściwość, wartość Name właściwości jest przypisywana do Name parametru polecenia cmdlet.For example, if the cmdlet has a Name parameter and the pipeline object also has a Name property, the value of the Name property is assigned to the Name parameter of the cmdlet. Wartość domyślna to false.The default is false.

ValueFromRemainingArguments (System. Boolean) opcjonalny nazwany parametr.ValueFromRemainingArguments (System.Boolean) Optional named parameter. True wskazuje, że parametr cmdlet akceptuje wszystkie pozostałe argumenty, które są przekazane do polecenia cmdlet.True indicates that the cmdlet parameter accepts all remaining arguments that are passed to the cmdlet. Wartość domyślna to false.The default is false.

HelpMessage Opcjonalny nazwany parametr.HelpMessage Optional named parameter. Określa Krótki opis parametru.Specifies a short description of the parameter. Program Windows PowerShell wyświetla ten komunikat, gdy polecenie cmdlet jest uruchamiane i nie określono obowiązkowego parametru.Windows PowerShell displays this message when a cmdlet is run and a mandatory parameter is not specified.

HelpMessageBaseName Opcjonalny nazwany parametr. Określa lokalizację, w której znajdują się identyfikatory zasobów.HelpMessageBaseName Optional named parameter.Specifies the location where resource identifiers reside. Na przykład ten parametr może określać zestaw zasobów zawierający komunikaty pomocy, które chcesz zlokalizować.For example, this parameter could specify a resource assembly that contains Help messages that you want to localize.

HelpMessageResourceId Opcjonalny nazwany parametr. Określa identyfikator zasobu dla komunikatu pomocy.HelpMessageResourceId Optional named parameter.Specifies the resource identifier for a Help message.

UwagiRemarks

  • Aby uzyskać więcej informacji na temat sposobu deklarowania tego atrybutu, zobacz How to DECLARE cmdlet Parameters.For more information about how to declare this attribute, see How to Declare Cmdlet Parameters.

  • Polecenie cmdlet może mieć dowolną liczbę parametrów.A cmdlet can have any number of parameters. Jednak dla lepszego środowiska użytkownika należy ograniczyć liczbę parametrów.However, for a better user experience, limit the number of parameters.

  • Parametry muszą być zadeklarowane dla publicznych pól niestatycznych lub właściwości.Parameters must be declared on public non-static fields or properties. Parametry powinny być zadeklarowane we właściwościach.Parameters should be declared on properties. Właściwość musi mieć akcesor zestawu publicznego, a jeśli ValueFromPipeline ValueFromPipelineByPropertyName słowo kluczowe or jest określone, właściwość musi mieć publiczny Akcesor get.The property must have a public set accessor, and if the ValueFromPipeline or ValueFromPipelineByPropertyName keyword is specified, the property must have a public get accessor.

  • Gdy określisz parametry pozycyjne, Ogranicz liczbę parametrów pozycyjnych w parametrze ustawionym na wartość mniejszą niż pięć.When you specify positional parameters, limit the number of positional parameters in a parameter set to less than five. Parametry pozycyjne nie muszą być ciągłe.And, positional parameters do not have to be contiguous. Położenia 5, 100 i 250 działają tak samo jak pozycje 0, 1 i 2.Positions 5, 100, and 250 work the same as positions 0, 1, and 2.

  • Gdy Position słowo kluczowe nie jest określone, parametr polecenia cmdlet musi być przywoływany przez jego nazwę.When the Position keyword is not specified, the cmdlet parameter must be referenced by its name.

  • W przypadku używania zestawów parametrów należy zwrócić uwagę na następujące kwestie:When you use parameter sets, note the following:

    • Każdy zestaw parametrów musi mieć co najmniej jeden unikatowy parametr.Each parameter set must have at least one unique parameter. Dobry projekt poleceń cmdlet wskazuje, że ten unikatowy parametr powinien również być obowiązkowy, jeśli jest to możliwe.Good cmdlet design indicates this unique parameter should also be mandatory if possible. Jeśli polecenie cmdlet zostało zaprojektowane do uruchamiania bez parametrów, unikatowy parametr nie może być obowiązkowy.If your cmdlet is designed to be run without parameters, the unique parameter cannot be mandatory.

    • Żaden zestaw parametrów nie powinien zawierać więcej niż jednego parametru pozycyjnego z tą samą pozycją.No parameter set should contain more than one positional parameter with the same position.

    • W zestawie parametrów należy zadeklarować tylko jeden parametr ValueFromPipeline = true .Only one parameter in a parameter set should declare ValueFromPipeline = true. Można zdefiniować wiele parametrów ValueFromPipelineByPropertyName = true .Multiple parameters can define ValueFromPipelineByPropertyName = true.

    • Można zdefiniować wiele parametrów ValueFromPipelineByPropertyName = true .Multiple parameters can define ValueFromPipelineByPropertyName = true.

  • Aby uzyskać więcej informacji na temat wytycznych dotyczących nazw parametrów, zobacz nazwy parametrów poleceń cmdlet.For more information about the guidelines for parameter names, see Cmdlet Parameter Names.

  • Atrybut Parameter jest zdefiniowany przez klasę System. Management. Automation. ParameterAttribute .The parameter attribute is defined by the System.Management.Automation.Parameterattribute class.

Zobacz teżSee Also

System. Management. Automation. ParameterAttributeSystem.Management.Automation.Parameterattribute

Nazwy parametrów polecenia cmdletCmdlet Parameter Names

Pisanie polecenia cmdlet programu Windows PowerShellWriting a Windows PowerShell Cmdlet