Typer av cmdlet-utdataTypes of cmdlet output

PowerShell tillhandahåller flera metoder som kan anropas av cmdlets för att generera utdata.PowerShell provides several methods that can be called by cmdlets to generate output. Dessa metoder använder en speciell åtgärd för att skriva utdata till en speciell data ström, till exempel data strömmen eller fel data strömmen.These methods use a specific operation to write their output to a specific data stream, such as the success data stream or the error data stream. I den här artikeln beskrivs de olika typerna av utdata och de metoder som används för att generera dem.This article describes the types of output and the methods used to generate them.

Typer av utdataTypes of output

Lyckade utdataSuccess output

-Cmdletar kan rapportera framgång genom att returnera ett objekt som kan bearbetas av nästa kommando i pipelinen.Cmdlets can report success by returning an object that can be processed by the next command in the pipeline. När cmdleten har slutfört åtgärden anropar cmdleten metoden system. Management. Automation. cmdlet. WriteObject .After the cmdlet has successfully performed its action, the cmdlet calls the System.Management.Automation.Cmdlet.WriteObject method. Vi rekommenderar att du anropar den här metoden i stället för metoderna system. Console. WriteLine eller system. Management. Automation. Host. PSHostUserInterface. WriteLine .We recommend that you call this method instead of the System.Console.WriteLine or System.Management.Automation.Host.PSHostUserInterface.WriteLine methods.

Du kan ange en Passthru växel parameter för cmdletar som vanligt vis inte returnerar objekt.You can provide a PassThru switch parameter for cmdlets that do not typically return objects. När växel parametern Passthru anges på kommando raden uppmanas cmdleten att returnera ett objekt.When the PassThru switch parameter is specified at the command line, the cmdlet is asked to return an object. Ett exempel på en-cmdlet som har en Passthru -parameter finns i Lägg till-historik.For an example of a cmdlet that has a PassThru parameter, see Add-History.

Fel utdataError output

Cmdlets kan rapportera fel.Cmdlets can report errors. När ett avbrotts fel inträffar genererar cmdleten ett undantag.When a terminating error occurs, the cmdlet throws an exception. När ett icke-avslutande fel inträffar anropar cmdleten metoden system. Management. Automation. Provider. CmdletProvider. WriteError för att skicka en fel post till fel data strömmen.When a non-terminating error occurs, the cmdlet calls the System.Management.Automation.Provider.CmdletProvider.WriteError method to send an error record to the error data stream. Mer information om fel rapportering finns i fel rapporterings koncept.For more information about error reporting, see Error Reporting Concepts.

Utförlig utdataVerbose output

Cmdletar kan ge värdefull information till dig medan cmdleten bearbetar poster korrekt genom att anropa metoden system. Management. Automation. cmdlet. WriteVerbose .Cmdlets can provide useful information to you while the cmdlet is correctly processing records by calling the System.Management.Automation.Cmdlet.WriteVerbose method. Metoden genererar utförliga meddelanden som visar hur åtgärden fortsätter.The method generates verbose messages that indicate how the action is proceeding.

Som standard visas inte utförliga meddelanden.By default, verbose messages are not displayed. Du kan ange verbose -parametern när cmdleten körs för att visa dessa meddelanden.You can specify the Verbose parameter when the cmdlet is run to display these messages. Verbose är en gemensam parameter som är tillgänglig för alla cmdletar.Verbose is a common parameter that is available to all cmdlets.

Förlopps utdataProgress output

-Cmdletar kan tillhandahålla information om förloppet när cmdleten utför aktiviteter som tar lång tid att slutföra, till exempel kopiering av en katalog rekursivt.Cmdlets can provide progress information to you when the cmdlet is performing tasks that take a long time to complete, such as copying a directory recursively. För att Visa förlopps information anropar cmdleten metoden system. Management. Automation. cmdlet. WriteProgress .To display progress information the cmdlet calls the System.Management.Automation.Cmdlet.WriteProgress method.

Fel söknings utdataDebug output

Cmdlets kan ge fel söknings meddelanden som är användbara vid fel sökning av cmdlet-koden.Cmdlets can provide debug messages that are helpful when troubleshooting the cmdlet code. För att Visa felsöknings information anropar cmdleten metoden system. Management. Automation. cmdlet. WriteDebug .To display debug information the cmdlet calls the System.Management.Automation.Cmdlet.WriteDebug method.

Som standard visas inte fel söknings meddelanden.By default, debug messages are not displayed. Du kan ange parametern Felsök när cmdleten körs för att visa dessa meddelanden.You can specify the Debug parameter when the cmdlet is run to display these messages. Debug är en gemensam parameter som är tillgänglig för alla cmdletar.Debug is a common parameter that is available to all cmdlets.

Varnings resultatWarning output

Cmdletar kan visa varnings meddelanden genom att anropa metoden system. Management. Automation. cmdlet. WriteWarning .Cmdlets can display warning messages by calling the System.Management.Automation.Cmdlet.WriteWarning method.

Varnings meddelanden visas som standard.By default, warning messages are displayed. Du kan dock konfigurera varnings meddelanden med hjälp av $WarningPreference variabeln eller genom att använda parametrarna verbose och Debug när cmdleten anropas.However, you can configure warning messages by using the $WarningPreference variable or by using the Verbose and Debug parameters when the cmdlet is called.

Visar utdataDisplaying output

För alla Skriv metods anrop bestäms innehålls visningen av vissa körnings variabler.For all write-method calls, the content display is determined by specific runtime variables. Undantaget är metoden system. Management. Automation. cmdlet. WriteObject .The exception is the System.Management.Automation.Cmdlet.WriteObject method. Genom att använda dessa variabler kan du göra ett lämpligt Skriv anrop på rätt plats i koden och inte bekymra dig om när eller om utdata ska visas.By using these variables, you can make the appropriate write call at the correct place in your code and not worry about when or if the output should be displayed.

Åtkomst till utmatnings funktionen för ett värd programAccessing the output functionality of a host application

Du kan också utforma en cmdlet för att direkt komma åt utmatnings funktionen för ett värd program via PowerShell-körningen.You can also design a cmdlet to directly access the output functionality of a host application through the PowerShell runtime. Med hjälp av de värd-API: er som tillhandahålls av PowerShell i stället för system. Console eller system. Windows. Forms säkerställer du att cmdleten fungerar med en mängd olika värdar.Using the host APIs provided by PowerShell instead of System.Console or System.Windows.Forms ensures that your cmdlet will work with a variety of hosts. Till exempel: powershell.exe konsol värd, powershell_ise.exe grafiska värd, PowerShell-fjärrkörnings värd och tredjepartsleverantörer.For example: the powershell.exe console host, the powershell_ise.exe graphical host, the PowerShell remoting host, and third-party hosts.

Se ävenSee also

Begrepp relaterade till felrapporteringError Reporting Concepts

Översikt över cmdletsCmdlet Overview

Skriva en Windows PowerShell-cmdletWriting a Windows PowerShell Cmdlet