Megosztás a következőn keresztül:

Paraméterattribútum-deklaráció

A Paraméter attribútum parancsmagparaméterként azonosítja a parancsmagosztály nyilvános tulajdonságát.

Szintaxis

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

Paraméterek

Mandatory (System.Boolean) Választható névvel ellátott paraméter. True azt jelzi, hogy a parancsmag paraméter szükséges. Ha a parancsmag meghívásakor nem ad meg kötelező paramétert, a Windows PowerShell egy paraméterérték megadását kéri a felhasználótól. Az alapértelmezett érték a false.

ParameterSetName (System.String) Választható névvel ellátott paraméter. Megadja azt a paraméterkészletet, amelyhez ez a parancsmag paraméter tartozik. Ha nincs megadva paraméterkészlet, a paraméter az összes paraméterkészlethez tartozik.

Position (System.Int32) Választható névvel ellátott paraméter. Megadja a paraméter helyét egy Windows PowerShell-parancson belül.

ValueFromPipeline (System.Boolean) Választható névvel ellátott paraméter. True azt jelzi, hogy a parancsmag paraméter egy folyamatobjektumból veszi át az értékét. Adja meg ezt a kulcsszót, ha a parancsmag a teljes objektumhoz fér hozzá, nem csak az objektum tulajdonságához. Az alapértelmezett érték a false.

ValueFromPipelineByPropertyName (System.Boolean) Választható névvel ellátott paraméter. True azt jelzi, hogy a parancsmag paraméter egy olyan folyamatobjektum tulajdonságából veszi az értékét, amelynek neve vagy aliasa megegyezik ezzel a paraméterrel. Ha például a parancsmag Name paraméterrel rendelkezik, és a folyamatobjektum is rendelkezik egy Name tulajdonsággal, a Name tulajdonság értéke a parancsmag Name paraméteréhez van rendelve. Az alapértelmezett érték a false.

ValueFromRemainingArguments (System.Boolean) Választható névvel ellátott paraméter. True azt jelzi, hogy a parancsmag paraméter elfogadja a parancsmagnak átadott összes többi argumentumot. Az alapértelmezett érték a false.

HelpMessage (System.String) Választható névvel ellátott paraméter. A paraméter rövid leírását adja meg. A Windows PowerShell akkor jeleníti meg ezt az üzenetet, ha egy parancsmag fut, és nincs megadva egy kötelező paraméter.

HelpMessageBaseName (System.String) Választható névvel ellátott paraméter. Megadja az erőforrás-azonosítók helyét. Ez a paraméter megadhat például egy erőforrás-szerelvényt, amely a honosítani kívánt súgóüzeneteket tartalmazza.

HelpMessageResourceId (System.String) Választható névvel ellátott paraméter. Megadja egy súgóüzenet erőforrás-azonosítóját.

DontShow (System.Boolean) Választható névvel ellátott paraméter. True azt jelzi, hogy a paraméter rejtve van a felhasználó elől a lapbővítéshez és az IntelliSense-hez. Az alapértelmezett érték a false.

Megjegyzések

  • További információ az attribútum deklarálásáról: Parancsmagparaméterek deklarálása.

  • A parancsmagok tetszőleges számú paraméterrel rendelkezhetnek. A jobb felhasználói élmény érdekében azonban korlátozza a paraméterek számát.

  • A paramétereket nyilvános, nem statikus mezőkön vagy tulajdonságokon kell deklarálni. A paramétereket tulajdonságokon kell deklarálni. A tulajdonságnak nyilvános készlettel kell rendelkeznie, és ha a ValueFromPipeline vagy ValueFromPipelineByPropertyName kulcsszó van megadva, a tulajdonságnak nyilvános lekéréses kiegészítővel kell rendelkeznie.

  • Pozícióparaméterek megadásakor a paraméterben lévő pozícióparaméterek számát ötnél kevesebbre korlátozza. A pozicionálási paramétereknek nem kell egybefüggőnek lenniük. Az 5., a 100. és a 250. pozíció ugyanúgy működik, mint a 0, az 1 és a 2. pozíció.

  • Ha a Position kulcsszó nincs megadva, a parancsmag paraméterére a nevével kell hivatkozni.

  • Paraméterkészletek használatakor vegye figyelembe a következőket:

    • Minden paraméterkészletnek legalább egy egyedi paramétert kell tartalmaznia. A jó parancsmag-kialakítás azt jelzi, hogy ezt az egyedi paramétert is kötelezőnek kell lennie, ha lehetséges. Ha a parancsmag úgy van kialakítva, hogy paraméterek nélkül fusson, az egyedi paraméter nem kötelező.

    • Egyetlen paraméterkészlet sem tartalmazhat egynél több azonos pozíciójú pozícióparamétert.

    • A paraméterkészletben csak egy paraméternek kell deklarálnia ValueFromPipeline = true.

    • Több paraméter is definiálhat ValueFromPipelineByPropertyName = true.

  • A paraméternevekre vonatkozó irányelvekről további információt Parancsmag paraméterneveicímű cikkben talál.

  • A paraméterattribútumot a System.Management.Automation.ParameterAttribute osztály határozza meg.

  • A DontShow paraméter a következő mellékhatásokat tartalmazza:

    • A társított paraméter összes paraméterkészletére hatással van, még akkor is, ha van olyan paraméterkészlet, amelyben a DontShow nincs használatban.
    • Elrejti a gyakori paramétereket a lapkiegészítésből és az IntelliSense-ből. DontShow nem rejti el a választható gyakori paramétereket: WhatIf, Confirmvagy UseTransaction.

Lásd még:

  • Last updated on