Názvy běžných parametrů

Článek
09/27/2021

Parametry popsané v tomto tématu se označují jako společné parametry. jsou přidány do rutin pomocí modulu runtime Windows PowerShell a nelze je deklarovat pomocí rutiny.

Poznámka

Tyto parametry jsou přidány také do rutin zprostředkovatelů a do funkcí, které jsou upraveny pomocí CmdletBinding atributu.

Obecné společné parametry

Následující parametry jsou přidány do všech rutin a lze je použít při každém spuštění rutiny. Tyto parametry jsou definovány třídou System. Management. Automation. Internal. CommonParameters .

Potvrdit (alias: CF)

Datový typ: přepínací parametr

Tento parametr určuje, zda má rutina zobrazit výzvu s výzvou, zda má uživatel jistotu, že má pokračovat.

Ladění (alias: DB)

Datový typ: přepínací parametr

Tento parametr určuje, zda zprávy ladění na úrovni programátora mohou být zobrazeny na příkazovém řádku. Tyto zprávy jsou určeny pro řešení potíží s operací rutiny a jsou generovány voláním metody System. Management. Automation. rutine. WriteDebug . Zprávy ladění není nutné lokalizovat.

ErrorAction (alias: EA)

Datový typ: výčet

Tento parametr určuje, jaká akce má probíhat při výskytu chyby. Možné hodnoty pro tento parametr jsou definovány výčtem System. Management. Automation. preferovaná akce .

ErrorVariable (alias: EV)

Datový typ: Řetězec

Tento parametr určuje proměnnou, do které se umístí objekty, když dojde k chybě. Chcete-li se připojit k této proměnné, použijte místo vymazání a nastavení proměnné hodnotu +název_proměnné .

Inbuffer (alias: PS)

Datový typ: Int32

Tento parametr definuje počet objektů, které se mají Uložit do výstupní vyrovnávací paměti předtím, než se všechny objekty přenesou do kanálu. Ve výchozím nastavení jsou objekty předány z kanálu okamžitě.

Subvariable (alias: OV)

Datový typ: Řetězec

Tento parametr určuje proměnnou, do které se mají umístit všechny výstupní objekty generované rutinou. Chcete-li se připojit k této proměnné, použijte místo vymazání a nastavení proměnné hodnotu +název_proměnné .

PipelineVariable (alias: PV)

Datový typ: Řetězec

Tento parametr ukládá hodnotu aktuálního prvku kanálu jako proměnnou pro libovolný pojmenovaný příkaz, který přetéká přes kanál.

Verbose (alias: VB)

Datový typ: přepínací parametr

Tento parametr určuje, zda rutina zapisuje vysvětlující zprávy, které lze zobrazit na příkazovém řádku. Tyto zprávy jsou určeny k poskytnutí další informace uživateli a jsou generovány voláním metody System. Management. Automation. rutine. WriteVerbose .

WarningAction (alias: WA)

Datový typ: výčet

Tento parametr určuje, jaká akce má probíhat, když rutina zapíše zprávu upozornění. Možné hodnoty pro tento parametr jsou definovány výčtem System. Management. Automation. preferovaná akce .

WarningVariable (alias: WV)

Datový typ: Řetězec

Tento parametr určuje proměnnou, ve které lze uložit zprávy upozornění. Chcete-li se připojit k této proměnné, použijte místo vymazání a nastavení proměnné hodnotu +název_proměnné .

Parametry Risk-Mitigation

Následující parametry jsou přidány do rutin, které žádají o potvrzení před provedením akce. Další informace o žádostech o potvrzení najdete v tématu vyžádání potvrzení. Tyto parametry jsou definovány třídou System. Management. Automation. Internal. Shouldprocessparameters .

WhatIf (alias: Wi)

Datový typ: přepínací parametr

Tento parametr určuje, zda rutina zapíše zprávu, která popisuje účinky spuštění rutiny bez skutečného provedení jakékoli akce.

Parametry transakce

Následující parametr je přidán do rutin, které podporují transakce. Tyto parametry jsou definovány třídou System. Management. Automation. Internal. Transactionparameters . Podpora transakcí byla představena v PowerShellu 3,0 a ukončená v PowerShellu 6,0.