Out-String

Out-String
    [-Width <Int32>]
    [-NoNewline]
    [-InputObject <PSObject>]
    [<CommonParameters>]

Out-String
    [-Stream]
    [-Width <Int32>]
    [-InputObject <PSObject>]
    [<CommonParameters>]

De cmdlet Out-String converteert invoerobjecten naar tekenreeksen. Standaard verzamelt Out-String de tekenreeksen en retourneert deze als één tekenreeks, maar u kunt de parameter Stream gebruiken om Out-String om één regel tegelijk te retourneren of een matrix met tekenreeksen te maken. Met deze cmdlet kunt u tekenreeksuitvoer zoeken en bewerken zoals in traditionele shells wanneer objectmanipulatie minder handig is.

PowerShell voegt ook de oss functie toe die Out-String -Stream aanroept als een verkorte manier om Out-String in een pijplijn te gebruiken.

In dit voorbeeld worden de landinstellingen voor de huidige gebruiker opgehaald en worden de objectgegevens geconverteerd naar tekenreeksen.

$C = Get-Culture | Select-Object -Property *
Out-String -InputObject $C -Width 100

Parent                         : en
LCID                           : 1033
KeyboardLayoutId               : 1033
Name                           : en-US
IetfLanguageTag                : en-US
DisplayName                    : English (United States)
NativeName                     : English (United States)
EnglishName                    : English (United States)
TwoLetterISOLanguageName       : en
ThreeLetterISOLanguageName     : eng
ThreeLetterWindowsLanguageName : ENU
CompareInfo                    : CompareInfo - en-US
TextInfo                       : TextInfo - en-US
IsNeutralCulture               : False
CultureTypes                   : SpecificCultures, InstalledWin32Cultures, FrameworkCultures
NumberFormat                   : System.Globalization.NumberFormatInfo
DateTimeFormat                 : System.Globalization.DateTimeFormatInfo
Calendar                       : System.Globalization.GregorianCalendar
OptionalCalendars              : {System.Globalization.GregorianCalendar,
                                 System.Globalization.GregorianCalendar}
UseUserOverride                : True
IsReadOnly                     : False

De variabele $C slaat een Selected.System.Globalization.CultureInfo-object op. Het object is het resultaat van Get-Culture uitvoer naar Select-Objectverzenden. De eigenschap parameter maakt gebruik van een sterretje (*) om alle eigenschappen op te geven zijn opgenomen in het object.

Out-String gebruikt de parameter InputObject om het object CultureInfo op te geven dat is opgeslagen in de variabele $C. De objecten in $C worden geconverteerd naar een tekenreeks.

In dit voorbeeld ziet u het verschil tussen het werken met objecten en het werken met tekenreeksen. Met de opdracht wordt een alias weergegeven die de tekst bevat gcm, de alias voor Get-Command.

Get-Alias | Out-String -Stream | Select-String -Pattern "gcm"

Alias           gcm -> Get-Command

Get-Alias haalt de System.Management.Automation.AliasInfo objecten op, één voor elke alias en verzendt de objecten omlaag in de pijplijn. Out-String gebruikt de parameter Stream om elk object te converteren naar een tekenreeks in plaats van alle objecten samen te voegen in één tekenreeks. De System.String--objecten worden naar de pijplijn verzonden en Select-String gebruikt de parameter Pattern om overeenkomsten te vinden voor de tekst gcm-.

Hoewel de meeste uitvoer van Out-String wordt verpakt naar de volgende regel, zijn er scenario's waarin de uitvoer wordt afgekapt door het opmaaksysteem voordat deze wordt doorgegeven aan Out-String. U kunt afkappen voorkomen met behulp van de parameter Width.

PS> @{TestKey = ('x' * 200)} | Out-String
Name                           Value
----                           -----
TestKey                        xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...

PS> @{TestKey = ('x' * 200)} | Out-String -Width 250

Name                           Value
----                           -----
TestKey                        xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

U kunt elk object doorsluisen naar deze cmdlet.

Deze cmdlet retourneert de tekenreeks die wordt gemaakt op basis van het invoerobject.

De cmdlets die het Out werkwoord bevatten, maken geen objecten op. De Out cmdlets verzenden objecten naar de formatter voor de opgegeven weergavebestemming.

PowerShell 7.2 heeft de mogelijkheid toegevoegd om te bepalen hoe ANSI-escapereeksen worden weergegeven. ANSI-ingerichte uitvoer die wordt doorgegeven aan Out-String kan worden gewijzigd op basis van de instelling van de eigenschap $PSStyle.OutputRendering. Zie about_ANSI_Terminalsvoor meer informatie.