Typer av cmdlet-utdata

PowerShell tillhandahåller flera metoder som kan anropas av cmdlets för att generera utdata. Dessa metoder använder en specifik åtgärd för att skriva sina utdata till en specifik dataström, till exempel dataströmmen för lyckad åtgärd eller feldataströmmen. I den här artikeln beskrivs typerna av utdata och de metoder som används för att generera dem.

Typer av utdata

Lyckade utdata

Cmdlets kan rapportera framgång genom att returnera ett objekt som kan bearbetas av nästa kommando i pipelinen. När cmdleten har utfört åtgärden anropar cmdleten metoden System.Management.Automation.Cmdlet.WriteObject. 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.

Du kan ange en PassThru-växelparameter för cmdlets som normalt inte returnerar objekt. När växlingsparametern PassThru anges på kommandoraden uppmanas cmdleten att returnera ett -objekt. Ett exempel på en cmdlet som har en PassThru-parameter finns i Add-History.

Felutdata

Cmdlets kan rapportera fel. När ett avslutande fel inträffar löste cmdleten ett undantag. När ett icke-avslutande fel inträffar anropar cmdleten metoden System.Management.Automation.Provider.CmdletProvider.WriteError för att skicka en felpost till feldataströmmen. Mer information om felrapportering finns i Felrapporteringsbegrepp.

Utförliga utdata

Cmdlets kan ge användbar information till dig medan cmdleten bearbetar poster korrekt genom att anropa metoden System.Management.Automation.Cmdlet.WriteVerbose. Metoden genererar utförliga meddelanden som anger hur åtgärden fortsätter.

Utförliga meddelanden visas inte som standard. Du kan ange den utförliga parametern när cmdleten körs för att visa dessa meddelanden. Utförlig är en vanlig parameter som är tillgänglig för alla cmdlets.

Förloppsutdata

Cmdlets kan ge dig förloppsinformation när cmdleten utför uppgifter som tar lång tid att slutföra, till exempel att kopiera en katalog rekursivt. För att visa förloppsinformation anropar cmdleten metoden System.Management.Automation.Cmdlet.WriteProgress.

Felsökningsutdata

Cmdlets kan tillhandahålla felsökningsmeddelanden som är användbara när du felsöker cmdlet-koden. Om du vill visa felsökningsinformation anropar cmdleten metoden System.Management.Automation.Cmdlet.WriteDebug.

Som standard visas inte felsökningsmeddelanden. Du kan ange parametern Debug när cmdleten körs för att visa dessa meddelanden. Felsökning är en vanlig parameter som är tillgänglig för alla cmdlets.

Varningsutdata

Cmdlets kan visa varningsmeddelanden genom att anropa metoden System.Management.Automation.Cmdlet.WriteWarning.

Som standard visas varningsmeddelanden. Du kan dock konfigurera varningsmeddelanden med hjälp av variabeln eller med hjälp av parametrarna Utförlig och Felsökning $WarningPreference när cmdleten anropas.

Visa utdata

För alla write-method-anrop bestäms innehållsvisningen av specifika körningsvariabler. Undantaget är metoden System.Management.Automation.Cmdlet.WriteObject. Med hjälp av dessa variabler kan du göra rätt skrivanrop på rätt plats i koden och inte bekymra dig om när eller om utdata ska visas.

Åtkomst till utdatafunktionen i ett värdprogram

Du kan också utforma en cmdlet för att få direkt åtkomst till utdatafunktionen i ett värdprogram via PowerShell-körningen. Använda de värd-API:er som tillhandahålls av PowerShell i stället för System.Console eller System.Windows. Formulär säkerställer att din cmdlet fungerar med en mängd olika värdar. Exempel:powershell.exe-konsolen, denpowershell_ise.exe grafiska värden, PowerShell-fjärrkommunikationsvärden och värdar från tredje part.

Se även

Begrepp relaterade till felrapportering

Översikt över cmdlets

Skriva en Windows PowerShell-cmdlet