Paraméterek attribútumdeklarációjaParameter Attribute Declaration

A paraméter attribútum a parancsmag osztály nyilvános tulajdonságát a parancsmag paraméterként azonosítja.The Parameter attribute identifies a public property of the cmdlet class as a cmdlet parameter.

SzintaxisSyntax

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

ParaméterekParameters

Mandatory (System. Boolean) választható elnevezett paraméter.Mandatory (System.Boolean) Optional named parameter. True azt jelzi, hogy a parancsmag paraméter megadása kötelező.True indicates the cmdlet parameter is required. Ha a parancsmag meghívásakor a kötelező paraméter nincs megadva, a Windows PowerShell egy paraméter értékének megadását kéri a felhasználótól.If a required parameter is not provided when the cmdlet is invoked, Windows PowerShell prompts the user for a parameter value. A mező alapértelmezett értéke: false.The default is false.

ParameterSetName (System. String) választható elnevezett paraméter.ParameterSetName (System.String) Optional named parameter. Azt a paramétert adja meg, amelyhez ez a parancsmag-paraméter tartozik.Specifies the parameter set that this cmdlet parameter belongs to. Ha nem ad meg paramétert, a paraméter az összes paraméter-készlethez tartozik.If no parameter set is specified, the parameter belongs to all parameter sets.

Position (System. Int32) választható elnevezett paraméter.Position (System.Int32) Optional named parameter. Megadja a paraméter pozícióját egy Windows PowerShell-parancson belül.Specifies the position of the parameter within a Windows PowerShell command.

ValueFromPipeline (System. Boolean) választható elnevezett paraméter.ValueFromPipeline (System.Boolean) Optional named parameter. True azt jelzi, hogy a parancsmag paraméter egy folyamat objektumból veszi az értékét.True indicates that the cmdlet parameter takes its value from a pipeline object. Adja meg ezt a kulcsszót, ha a parancsmag a teljes objektumhoz fér hozzá, nem csak az objektum tulajdonsága.Specify this keyword if the cmdlet accesses the complete object, not just a property of the object. A mező alapértelmezett értéke: false.The default is false.

ValueFromPipelineByPropertyName (System. Boolean) választható elnevezett paraméter.ValueFromPipelineByPropertyName (System.Boolean) Optional named parameter. True azt jelzi, hogy a parancsmag paraméter értéke egy olyan folyamat-objektum tulajdonsága, amelynek a neve megegyezik a paraméterrel megegyező névvel vagy aliassal.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. Ha például a parancsmag egy Name paraméterrel rendelkezik, és a folyamat objektuma is rendelkezik Name tulajdonsággal, a tulajdonság értéke a Name Name parancsmag paraméteréhez lesz rendelve.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. A mező alapértelmezett értéke: false.The default is false.

ValueFromRemainingArguments (System. Boolean) választható elnevezett paraméter.ValueFromRemainingArguments (System.Boolean) Optional named parameter. True azt jelzi, hogy a parancsmag paraméter fogadja a parancsmagnak átadott összes hátralévő argumentumot.True indicates that the cmdlet parameter accepts all remaining arguments that are passed to the cmdlet. A mező alapértelmezett értéke: false.The default is false.

HelpMessage Választható elnevezett paraméter.HelpMessage Optional named parameter. A paraméter rövid leírását adja meg.Specifies a short description of the parameter. A Windows PowerShell megjeleníti ezt az üzenetet, amikor egy parancsmag fut, és nincs megadva kötelező paraméter.Windows PowerShell displays this message when a cmdlet is run and a mandatory parameter is not specified.

HelpMessageBaseName Választható elnevezett paraméter. Megadja azt a helyet, ahol az erőforrás-azonosítók találhatók.HelpMessageBaseName Optional named parameter.Specifies the location where resource identifiers reside. Ez a paraméter például megadhat egy olyan erőforrás-szerelvényt, amely a honosítani kívánt súgótémaköröket tartalmazza.For example, this parameter could specify a resource assembly that contains Help messages that you want to localize.

HelpMessageResourceId Választható elnevezett paraméter. Megadja egy súgó üzenet erőforrás-azonosítóját.HelpMessageResourceId Optional named parameter.Specifies the resource identifier for a Help message.

MegjegyzésekRemarks

  • További információ az attribútum bevallásáról: a parancsmag paramétereinek deklarálása.For more information about how to declare this attribute, see How to Declare Cmdlet Parameters.

  • Egy parancsmag tetszőleges számú paramétert tartalmazhat.A cmdlet can have any number of parameters. A jobb felhasználói élmény érdekében azonban korlátozza a paraméterek számát.However, for a better user experience, limit the number of parameters.

  • A paramétereket deklarálni kell a nyilvános, nem statikus mezőkön vagy tulajdonságokon.Parameters must be declared on public non-static fields or properties. A paramétereket deklarálni kell a tulajdonságok elemnél.Parameters should be declared on properties. A tulajdonságnak rendelkeznie kell egy nyilvános készlet-hozzáféréssel, és ha a ValueFromPipeline vagy a ValueFromPipelineByPropertyName kulcsszó meg van adva, akkor a tulajdonságnak nyilvános get-hozzáférési jogosultsággal kell rendelkeznie.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.

  • Ha a pozíciós paramétereket adja meg, a paraméterben szereplő pozíciós paraméterek számát állítsa legfeljebb öt értékre.When you specify positional parameters, limit the number of positional parameters in a parameter set to less than five. A és a pozíciós paramétereknek nem kell folytonos lenniük.And, positional parameters do not have to be contiguous. Az 5, 100 és 250 pozíciók ugyanúgy működnek, mint a 0, az 1 és a 2.Positions 5, 100, and 250 work the same as positions 0, 1, and 2.

  • Ha a Position kulcsszó nincs megadva, a parancsmag paramétert a neve alapján kell hivatkozni.When the Position keyword is not specified, the cmdlet parameter must be referenced by its name.

  • Paraméter-készletek használatakor vegye figyelembe a következőket:When you use parameter sets, note the following:

    • Minden paraméter-készletnek legalább egy egyedi paraméterrel kell rendelkeznie.Each parameter set must have at least one unique parameter. A jó parancsmag kialakítása azt jelzi, hogy ezt az egyedi paramétert is kötelező megadni, ha lehetséges.Good cmdlet design indicates this unique parameter should also be mandatory if possible. Ha a parancsmagot paraméterek nélkül szeretné futtatni, az egyedi paraméter nem kötelező.If your cmdlet is designed to be run without parameters, the unique parameter cannot be mandatory.

    • Egyetlen beállításhalmaz nem tartalmazhat egynél több pozíciós paramétert ugyanazzal a pozícióval.No parameter set should contain more than one positional parameter with the same position.

    • Egy paraméterben csak egy paraméter deklarálható ValueFromPipeline = true .Only one parameter in a parameter set should declare ValueFromPipeline = true. Több paraméter is megadható ValueFromPipelineByPropertyName = true .Multiple parameters can define ValueFromPipelineByPropertyName = true.

    • Több paraméter is megadható ValueFromPipelineByPropertyName = true .Multiple parameters can define ValueFromPipelineByPropertyName = true.

  • További információ a paraméterek neveinek irányelveiről: parancsmag-paraméterek nevei.For more information about the guidelines for parameter names, see Cmdlet Parameter Names.

  • A paraméter attribútumot a System. Management. Automation. Parameterattribute osztály határozza meg.The parameter attribute is defined by the System.Management.Automation.Parameterattribute class.

Lásd még:See Also

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

Parancsmag-paraméterek neveiCmdlet Parameter Names

Windows PowerShell-parancsmag írásaWriting a Windows PowerShell Cmdlet