Parancsmagok attribútumdeklarációja

A Parancsmag attribútum parancsmagként azonosít egy Microsoft .NET-keretrendszerosztályt, és megadja a parancsmag meghívásához használt igét és főnevet.

Szinopszis

[Cmdlet("verbName", "nounName")]
[Cmdlet("verbName", "nounName", Named Parameters...)]

Paraméterek

VerbName (System.String) Kötelező. A parancsmag-igét adja meg. Ez az ige határozza meg a parancsmag által végrehajtott műveletet. A jóváhagyott parancsmag-parancsmagokkal kapcsolatos további információkért lásd parancsmagok parancsmagneveit és szükséges fejlesztési útmutatókat.

NounName (System.String) Kötelező. Megadja a parancsmag főnevét. Ez a főnév határozza meg azt az erőforrást, amelyre a parancsmag hat. További információ a parancsmagok főneveiről: parancsmag-deklaráció és erősen ajánlott fejlesztési irányelvek.

SupportsShouldProcess (System.Boolean) Választható névvel ellátott paraméter. True azt jelzi, hogy a parancsmag támogatja a System.Management.Automation.Cmdlet.ShouldProcess metódus hívásait, amely lehetővé teszi a parancsmag számára, hogy a rendszer módosítását megelőző művelet előtt kérje meg a felhasználót. False, az alapértelmezett érték azt jelzi, hogy a parancsmag nem támogatja a System.Management.Automation.Cmdlet.ShouldProcess metódus hívásait. A megerősítési kérelmekről további információt a Megerősítés kérése című témakörben talál.

ConfirmImpact (System.Management.Automation.ConfirmImpact) Nem kötelező elnevezett paraméter. Megadja, hogy a parancsmag műveletét mikor kell megerősíteni a System.Management.Automation.Cmdlet.ShouldProcess metódus hívásával. System.Management.Automation.Cmdlet.ShouldProcess csak akkor lesz meghívva, ha a parancsmag ConfirmImpact értéke (alapértelmezés szerint közepes) értéke egyenlő vagy nagyobb, mint a $ConfirmPreference változó értéke. Ezt a paramétert csak akkor kell megadni, ha a SupportsShouldProcess paraméter meg van adva.

DefaultParameterSetName (System.String) Választható névvel ellátott paraméter. Megadja azt az alapértelmezett paraméterkészletet, amelyet a Windows PowerShell-futtatókörnyezet akkor próbál használni, ha nem tudja meghatározni, hogy melyik paraméterkészletet használja. Figyelje meg, hogy ez a helyzet kiküszöbölhető azáltal, hogy az egyes paraméterek egyedi paramétere kötelező paramétert állít be.

Van egy olyan eset, amikor a Windows PowerShell akkor sem tudja használni az alapértelmezett paraméterkészletet, ha az alapértelmezett paraméterkészlet neve meg van adva. A Windows PowerShell-futtatókörnyezet nem tud különbséget tenni a kizárólag objektumtípuson alapuló paraméterkészletek között. Ha például van egy paraméterkészlete, amely egy sztringet használ fájlelérési útvonalként, és egy másik olyan készletet, amely közvetlenül egy FileInfo objektumot vesz igénybe, a Windows PowerShell nem tudja meghatározni, hogy melyik paraméterkészletet használja a parancsmagnak átadott értékek alapján, és nem használja az alapértelmezett paraméterkészletet sem. Ebben az esetben még akkor is, ha alapértelmezett paraméterkészletnevet ad meg, a Windows PowerShell nem egyértelmű paraméterkészlettel kapcsolatos hibaüzenetet küld.

SupportsTransactions (System.Boolean) Választható névvel ellátott paraméter. True azt jelzi, hogy a parancsmag használható egy tranzakción belül. Ha True van megadva, a Windows PowerShell-futtatókörnyezet hozzáadja a UseTransaction paramétert a parancsmag paraméterlistájához. False, az alapértelmezett érték azt jelzi, hogy a parancsmag nem használható tranzakción belül.

Megjegyzések

• Az ige és a főnév együttesen a regisztrált parancsmag azonosítására és a parancsmag parancsfájlon belüli meghívására szolgál.

• Amikor a parancsmagot a Windows PowerShell-konzolról hívja meg, a parancs a következő parancshoz hasonlít:

VerbName-NounName

• A Windows PowerShell-en kívüli erőforrásokat módosító parancsmagoknak tartalmazniuk kell a SupportsShouldProcess kulcsszót a Parancsmag attribútum deklarálásakor, amely lehetővé teszi, hogy a parancsmag meghívja a System.Management.Automation.Cmdlet.Cmdlet.ShouldProcess metódust, mielőtt a parancsmag végrehajtja a műveletet. Ha a System.Management.Automation.Cmdlet.ShouldProcess hívás falsead vissza, a művelet nem végezhető el. A System.Management.Automation.Cmdlet.ShouldProcess hívás által generált megerősítési kérelmekről további információt a Megerősítés kérésecímű témakörben talál.

A Confirm és WhatIf parancsmagparaméterek csak a System.Management.Automation.Cmdlet.Should Process hívásokat támogató parancsmagokhoz érhetők el.

Példa

Az alábbi osztálydefiníció a Parancsmag attribútummal azonosítja a .NET-keretrendszer osztályt egy Get-Proc parancsmaghoz, amely információkat kér le a helyi számítógépen futó folyamatokról.

[Cmdlet(VerbsCommon.Get, "Proc")]
public class GetProcCommand : Cmdlet

A Get-Proc parancsmaggal kapcsolatos további információkért lásd GetProc-oktatóanyag.

Lásd még:

Windows PowerShell-parancsmag írása