Deklaration av attributet ParameterParameter Attribute Declaration

Attributet parameter identifierar en offentlig egenskap för cmdlet-klassen som en cmdlet-parameter.The Parameter attribute identifies a public property of the cmdlet class as a cmdlet parameter.

SyntaxSyntax

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

ParametrarParameters

Mandatory (System. Boolean) valfri namngiven parameter.Mandatory (System.Boolean) Optional named parameter. True anger att cmdlet-parametern är obligatorisk.True indicates the cmdlet parameter is required. Om en obligatorisk parameter inte anges när cmdleten anropas, uppmanas användaren att ange ett parameter värde i Windows PowerShell.If a required parameter is not provided when the cmdlet is invoked, Windows PowerShell prompts the user for a parameter value. Standardvärdet är false.The default is false.

ParameterSetName (System. String) valfri namngiven parameter.ParameterSetName (System.String) Optional named parameter. Anger den parameter uppsättning som denna cmdlet-parameter tillhör.Specifies the parameter set that this cmdlet parameter belongs to. Om ingen parameter uppsättning anges tillhör parametern alla parameter uppsättningar.If no parameter set is specified, the parameter belongs to all parameter sets.

Position (System. Int32) valfri namngiven parameter.Position (System.Int32) Optional named parameter. Anger positionen för parametern i ett Windows PowerShell-kommando.Specifies the position of the parameter within a Windows PowerShell command.

ValueFromPipeline (System. Boolean) valfri namngiven parameter.ValueFromPipeline (System.Boolean) Optional named parameter. True anger att cmdlet-parametern tar sitt värde från ett pipeline-objekt.True indicates that the cmdlet parameter takes its value from a pipeline object. Ange det här nyckelordet om cmdleten har åtkomst till det fullständiga objektet, inte bara en egenskap för objektet.Specify this keyword if the cmdlet accesses the complete object, not just a property of the object. Standardvärdet är false.The default is false.

ValueFromPipelineByPropertyName (System. Boolean) valfri namngiven parameter.ValueFromPipelineByPropertyName (System.Boolean) Optional named parameter. True anger att cmdlet-parametern tar värdet från en egenskap för ett pipeline-objekt som har antingen samma namn eller samma alias som denna parameter.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. Om till exempel cmdleten har en Name parameter och pipelinen också har en Name egenskap, tilldelas värdet för Name egenskapen till Name parametern för cmdleten.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. Standardvärdet är false.The default is false.

ValueFromRemainingArguments (System. Boolean) valfri namngiven parameter.ValueFromRemainingArguments (System.Boolean) Optional named parameter. True anger att cmdlet-parametern accepterar alla återstående argument som skickas till cmdleten.True indicates that the cmdlet parameter accepts all remaining arguments that are passed to the cmdlet. Standardvärdet är false.The default is false.

HelpMessage Valfri namngiven parameter.HelpMessage Optional named parameter. Anger en kort beskrivning av parametern.Specifies a short description of the parameter. Windows PowerShell visar det här meddelandet när en cmdlet körs och en obligatorisk parameter inte har angetts.Windows PowerShell displays this message when a cmdlet is run and a mandatory parameter is not specified.

HelpMessageBaseName Valfri namngiven parameter.HelpMessageBaseName Optional named parameter. Anger den plats där resurs identifierare finns.Specifies the location where resource identifiers reside. Den här parametern kan till exempel ange en resurs sammansättning som innehåller hjälp meddelanden som du vill lokalisera.For example, this parameter could specify a resource assembly that contains Help messages that you want to localize.

HelpMessageResourceId Valfri namngiven parameter. Anger resurs-ID för ett hjälp meddelande.HelpMessageResourceId Optional named parameter.Specifies the resource identifier for a Help message.

KommentarerRemarks

  • Mer information om hur du deklarerar det här attributet finns i så här deklarerar du cmdlet-parametrar.For more information about how to declare this attribute, see How to Declare Cmdlet Parameters.

  • En cmdlet kan ha valfritt antal parametrar.A cmdlet can have any number of parameters. För en bättre användar upplevelse begränsar du dock antalet parametrar.However, for a better user experience, limit the number of parameters.

  • Parametrar måste deklareras för offentliga fält eller egenskaper som inte är statiska.Parameters must be declared on public non-static fields or properties. Parametrar ska deklareras för egenskaper.Parameters should be declared on properties. Egenskapen måste ha en offentlig set-accessor, och om ValueFromPipeline ValueFromPipelineByPropertyName nyckelordet eller har angetts måste egenskapen ha en offentlig get-accessor.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.

  • Om du anger positions parametrar begränsar du antalet positions parametrar i en parameter till mindre än fem.When you specify positional parameters, limit the number of positional parameters in a parameter set to less than five. Positions parametrar behöver inte vara sammanhängande.And, positional parameters do not have to be contiguous. Positionerna 5, 100 och 250 fungerar på samma sätt som positionerna 0, 1 och 2.Positions 5, 100, and 250 work the same as positions 0, 1, and 2.

  • Om Position nyckelordet inte anges måste cmdlet-parametern refereras till med dess namn.When the Position keyword is not specified, the cmdlet parameter must be referenced by its name.

  • Tänk på följande när du använder parameter uppsättningar:When you use parameter sets, note the following:

    • Varje parameter uppsättning måste ha minst en unik parameter.Each parameter set must have at least one unique parameter. Design av lämplig cmdlet anger att den här unika parametern också bör vara obligatorisk om möjligt.Good cmdlet design indicates this unique parameter should also be mandatory if possible. Om cmdleten har utformats för att köras utan parametrar kan den unika parametern inte vara obligatorisk.If your cmdlet is designed to be run without parameters, the unique parameter cannot be mandatory.

    • Ingen parameter uppsättning måste innehålla mer än en positions parameter med samma position.No parameter set should contain more than one positional parameter with the same position.

    • Endast en parameter i en parameter uppsättning bör deklarera ValueFromPipeline = true .Only one parameter in a parameter set should declare ValueFromPipeline = true.

    • Flera parametrar kan definieras ValueFromPipelineByPropertyName = true .Multiple parameters can define ValueFromPipelineByPropertyName = true.

  • Mer information om rikt linjerna för parameter namn finns i cmdlet parameter Names.For more information about the guidelines for parameter names, see Cmdlet Parameter Names.

  • Attributet parameter definieras av klassen system. Management. Automation. Parameterattribute .The parameter attribute is defined by the System.Management.Automation.Parameterattribute class.

Se ävenSee Also

System. Management. Automation. ParameterattributeSystem.Management.Automation.Parameterattribute

Parameter namn för cmdletCmdlet Parameter Names

Skriva en Windows PowerShell-cmdletWriting a Windows PowerShell Cmdlet