Paraméterek attribútumdeklarációja

  • Cikk

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

Szintaxis

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

Paraméterek

Mandatory (System.Boolean) Nem kötelező elnevezett paraméter. True A azt jelzi, hogy a parancsmag-paraméter megadása kötelező. Ha nem ad meg kötelező paramétert a parancsmag meghívásakor, a Windows PowerShell egy paraméterértéket kér a felhasználótól. A mező alapértelmezett értéke: false.

ParameterSetName (System.String) Nem kötelező elnevezett 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) Nem kötelező elnevezett paraméter. A paraméter pozícióját adja meg egy Windows PowerShell parancsban.

ValueFromPipeline (System.Boolean) Nem kötelező elnevezett paraméter. True A azt jelzi, hogy a parancsmag paramétere egy folyamatobjektumból veszi át az értékét. Akkor adja meg ezt a kulcsszót, ha a parancsmag a teljes objektumhoz hozzáfér, nem csak az objektum tulajdonságához. A mező alapértelmezett értéke: false.

ValueFromPipelineByPropertyName (System.Boolean) Nem kötelező elnevezett paraméter. True A azt jelzi, hogy a parancsmag paramétere egy olyan folyamatobjektum tulajdonságának értékét veszi fel, amely ugyanazokkal a névvel vagy aliasokkal rendelkezik, mint ez a paraméter. Ha például a parancsmag rendelkezik egy paraméterrel, és a folyamatobjektum is rendelkezik egy tulajdonságmal, a tulajdonság értéke a parancsmag paramétere lesz Name Name Name Name hozzárendelve. A mező alapértelmezett értéke: false.

ValueFromRemainingArguments (System.Boolean) Nem kötelező elnevezett paraméter. True A azt jelzi, hogy a parancsmag paramétere a parancsmagnak átadott összes fennmaradó argumentumot elfogadja. A mező alapértelmezett értéke: false.

HelpMessage Nem kötelező elnevezett paraméter. Megadja a paraméter rövid leírását. Windows PowerShell ezt az üzenetet jeleníti meg, ha parancsmag fut, és nincs megadva kötelező paraméter.

HelpMessageBaseName Nem kötelező elnevezett paraméter. Megadja az erőforrás-azonosítók helyét. Ez a paraméter például megadhat egy erőforrás-szerelvényt, amely a honosítani kívánt súgóüzeneteket tartalmazza.

HelpMessageResourceId Nem kötelező elnevezett paraméter. Megadja a súgóüzenet erőforrás-azonosítóját.

Megjegyzések

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

  • Egy parancsmagnak bármilyen számú paramétere lehet. 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 halmaz-hozzáféréssel kell lennie, és ha az or kulcsszó meg van adva, akkor a tulajdonságnak nyilvános get ValueFromPipeline ValueFromPipelineByPropertyName accessor-nak kell lennie.

  • Pozícióparaméterek megadásakor korlátozza egy paraméterkészlet pozícióparaméterének számát ötnél kevesebbre. A pozícióparamétereknek pedig nem kell összefüggőnek lennie. Az 5, 100 és 250 pozíció ugyanúgy működik, mint a 0, az 1 és a 2 pozíció.

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

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

    • Minden paraméterkészletnek legalább egy egyedi paraméterrel kell lennie. A parancsmagok jó kialakítása azt jelzi, hogy ennek az egyedi paraméternek is kötelezőnek kell lennie, ha lehetséges. Ha a parancsmagot paraméterek nélkül való futtatásra tervezték, az egyedi paraméter nem lehet kötelező.

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

    • Egy paraméterkészletben csak egy paraméter deklarálva kell ValueFromPipeline = true lennie.

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

  • További információ a paraméternevekre vonatkozó irányelvekről: Parancsmagparaméterek nevei.

  • A paraméterattribútum a System.Management.Automation.Parameterattribute osztály által van meghatározva.

Lásd még:

System.Management.Automation.Parameterattribute

Parancsmag-paraméterek nevei

Windows PowerShell-parancsmag írása