Gyakori paraméternevek

Cikk
09/27/2021

A jelen témakörben ismertetett paramétereket gyakori paramétereknek nevezzük. A parancsmagok hozzáadják őket a Windows PowerShell, és a parancsmag nem deklarálhatja őket.

Megjegyzés

Ezek a paraméterek a szolgáltatói parancsmagok és a attribútummal ékelt függvények számára is CmdletBinding hozzáadva.

Általános gyakori paraméterek

A következő paramétereket a rendszer hozzáadja az összes parancsmaghoz, és a parancsmag minden futtatásakor elérhető. Ezeket a paramétereket a System.Management.Automation.Internal.Commonparameters osztály határozza meg.

Megerősítés (alias: cf)

Adattípus: SwitchParameter

Ez a paraméter határozza meg, hogy a parancsmag megjelenít-e egy kérdést, amely megkérdezi, hogy a felhasználó biztos-e a folytatásban.

Hibakeresés (alias: db)

Adattípus: SwitchParameter

Ez a paraméter határozza meg, hogy a programozószintű hibakeresési üzenetek megjeleníthetőek-e a parancssorban. Ezek az üzenetek a parancsmag működésének hibaelhárítására szolgálnak, és a System.Management.Automation.Cmdlet.WriteDebug metódus hívásával jönnek létre. A hibakeresési üzeneteket nem kell honosítottként végezni.

ErrorAction (alias: ea)

Adattípus: Enumerálás

Ez a paraméter határozza meg, hogy milyen műveletet kell eltennünk hiba esetén. A paraméter lehetséges értékeit a System.Management.Automation.Actionpreference enumerálás határozza meg.

ErrorVariable (alias: ev)

Adattípus: Sztring

Ez a paraméter határozza meg azt a változót, amelyben hiba esetén objektumokat kell helyezzen el. A változóhoz való hozzáfűzéshez használja a +varname paramétert a változó törlése és beállítása helyett.

OutBuffer (alias: ob)

Adattípus: Int32

Ez a paraméter határozza meg a kimeneti pufferben tárolt objektumok számát, mielőtt az objektumok tovább lenne adva a folyamatnak. Alapértelmezés szerint az objektumokat a rendszer azonnal továbbküldi a folyamatnak.

OutVariable (alias: ov)

Adattípus: Sztring

Ez a paraméter határozza meg azt a változót, amelybe a parancsmag által létrehozott összes kimeneti objektumot el kell helyezze. A változóhoz való hozzáfűzéshez használja a +varname paramétert a változó törlése és beállítása helyett.

PipelineVariable (alias: pv)

Adattípus: Sztring

Ez a paraméter az aktuális folyamatelem értékét változóként tárolja bármely nevestűs parancshoz, amely végigfut a folyamaton.

Részletes (alias: vb)

Adattípus: SwitchParameter

Ez a paraméter határozza meg, hogy a parancsmag ír-e magyarázó üzeneteket, amelyek megjeleníthetőek a parancssorban. Ezek az üzenetek további segítséget nyújtanak a felhasználónak, és a System.Management.Automation.Cmdlet.WriteVerbose metódus hívásával jönnek létre.

WarningAction (alias: wa)

Adattípus: Enumerálás

Ez a paraméter határozza meg, hogy milyen műveletet kell eltennünk, amikor a parancsmag figyelmeztető üzenetet ír. A paraméter lehetséges értékeit a System.Management.Automation.Actionpreference enumerálás határozza meg.

WarningVariable (alias: wv)

Adattípus: Sztring

Ez a paraméter határozza meg azt a változót, amelybe a figyelmeztető üzenetek menthetők. A változóhoz való hozzáfűzéshez használja a +varname paramétert a változó törlése és beállítása helyett.

Risk-Mitigation paraméterek

Az alábbi paramétereket a rendszer hozzáadja a parancsmagokhoz, amelyek megerősítést kérnek a művelet végrehajtása előtt. A megerősítési kérésekkel kapcsolatos további információkért lásd: Megerősítés kérése. Ezeket a paramétereket a System.Management.Automation.Internal.Shouldprocessparameters osztály határozza meg.

WhatIf (alias: wi)

Adattípus: SwitchParameter

Ez a paraméter határozza meg, hogy a parancsmag olyan üzenetet ír-e, amely leírja a parancsmag futtatásának hatásait anélkül, hogy ténylegesen bármilyen műveletet hajt végre.

Tranzakciós paraméterek

A tranzakciókat támogató parancsmagok a következő paraméterrel egészülnek ki. Ezeket a paramétereket a System.Management.Automation.Internal.Transactionparameters osztály határozza meg. A tranzakciótámogatás a PowerShell 3.0-ban lett bevezetve, és a PowerShell 6.0-ban megszűnt.