Typy výstupu rutin

PowerShell poskytuje několik metod, které mohou rutiny volat pro vygenerování výstupu. Tyto metody používají konkrétní operaci k zápisu výstupu do konkrétního datového proudu, jako je například datový proud úspěšných dat nebo datový proud chyb. Tento článek popisuje typy výstupu a metody, které se používají k jejich vygenerování.

Typy výstupu

Výstup úspěchu

Rutiny mohou ohlásit úspěch vrácením objektu, který lze zpracovat dalším příkazem v kanálu. Po úspěšném provedení akce rutina volá metodu System.Management.Automation.Cmdlet.WriteObject. Tuto metodu doporučujeme volat místo metod System.Console.WriteLine nebo System.Management.Automation.Host.PSHostUserInterface.WriteLine.

Pro rutiny, které obvykle nevracejí objekty, můžete zadat přepínací parametr PassThru. Pokud je na příkazovém řádku zadán parametr přepínače PassThru, je rutina vyzvána k vrácení objektu. Příklad rutiny s parametrem PassThru najdete v tématu Add-History.

Výstup chyby

Rutiny mohou hlásit chyby. Když dojde k ukončující chybě, rutina vyvolá výjimku. Pokud dojde k neukončující chybě, rutina zavolá metodu System.Management.Automation.Provider.CmdletProvider.WriteError, která odešle záznam chyby do datového proudu chyb. Další informace o zasílání zpráv o chybách najdete v tématu Koncepty zasílání zpráv o chybách.

Podrobný výstup

Rutiny vám mohou poskytnout užitečné informace, zatímco rutina správně zpracovává záznamy voláním metody System.Management.Automation.Cmdlet.WriteVerbose. Metoda generuje podrobné zprávy, které indikují, jak akce pokračuje.

Ve výchozím nastavení se podrobné zprávy nezobrazují. Při spuštění rutiny můžete zadat parametr Verbose, který tyto zprávy zobrazí. Podrobný parametr je společný parametr, který je k dispozici pro všechny rutiny.

Výstup průběhu

Rutiny vám mohou poskytnout informace o průběhu, když rutina provádí úlohy, které trvá dlouho, například rekurzivně kopírovat adresář. K zobrazení informací o průběhu rutina volá metodu System.Management.Automation.Cmdlet.WriteProgress.

Výstup ladění

Rutiny mohou poskytovat zprávy ladění, které jsou užitečné při řešení potíží s kódem rutiny. K zobrazení ladicích informací rutina volá metodu System.Management.Automation.Cmdlet.WriteDebug.

Ve výchozím nastavení se zprávy ladění nezobrazují. Při spuštění rutiny můžete zadat parametr Debug, který tyto zprávy zobrazí. Ladění je společný parametr, který je k dispozici pro všechny rutiny.

Výstup upozornění

Rutiny mohou zobrazit varovné zprávy voláním metody System.Management.Automation.Cmdlet.WriteWarning.

Ve výchozím nastavení se zobrazují varovné zprávy. Upozornění však můžete nakonfigurovat pomocí proměnné nebo pomocí parametrů Podrobné a Ladit při volání $WarningPreference rutiny.

Zobrazení výstupu

Pro všechna volání metod zápisu je zobrazení obsahu určeno konkrétními proměnnými modulu runtime. Výjimkou je metoda System.Management.Automation.Cmdlet.WriteObject. Pomocí těchto proměnných můžete provést příslušné volání zápisu na správném místě v kódu a nemusíte si dělat starosti s tím, kdy nebo jestli se má zobrazit výstup.

Přístup k funkci výstupu hostitelské aplikace

Můžete také navrhnout rutinu pro přímý přístup k výstupní funkci hostitelské aplikace prostřednictvím modulu runtime PowerShellu. Použití hostitelských rozhraní API poskytovaných powershellem místo System.Console nebo System.Windows. Formuláře zajišťují, že vaše rutina bude fungovat s různými hostiteli. Příklad: hostitel powershell.exe konzoly, hostitel powershell_ise.exe, hostitel vzdálené komunikace PowerShellu a hostitelé třetích stran.

Viz také

Koncepty zasílání zpráv o chybách

Přehled rutin

Vytvoření rutiny Windows PowerShellu