Out-String
Hiermee worden objecten als een reeks tekenreeksen naar de host verzonden.
Syntax
Default (Standaard)
Out-String
[-Stream]
[-Width <Int32>]
[-InputObject <PSObject>]
[<CommonParameters>]
Description
Met de cmdlet Out-String worden de objecten die door Windows PowerShell worden beheerd, geconverteerd naar een matrix met 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 tekenreeks tegelijk te retourneren.
Met deze cmdlet kunt u tekenreeksuitvoer zoeken en bewerken zoals in traditionele shells wanneer objectmanipulatie minder handig is.
Voorbeelden
Voorbeeld 1: Tekst als tekenreeks naar de console uitvoeren
PS C:\> Get-Content C:\test1\testfile2.txt | Out-String
Met deze opdracht wordt de inhoud van het Testfile2.txt-bestand als één tekenreeks naar de console verzonden.
De cmdlet Get-Content wordt gebruikt om de inhoud van het bestand op te halen.
De pijplijnoperator (|) verzendt de inhoud naar Out-String, waarmee de inhoud als een tekenreeks naar de console wordt verzonden.
Voorbeeld 2: Haal de huidige cultuur op en converteer de gegevens naar tekenreeksen
De eerste opdracht maakt gebruik van de Get-Culture cmdlet om de landinstellingen op te halen.
De pijplijnoperator (|) verzendt het resultaat naar de cmdlet Select-Object, waarmee alle eigenschappen (*) van het cultuurobject worden geselecteerd dat Get-Culture geretourneerd.
Met de opdracht worden de resultaten vervolgens opgeslagen in de variabele $C.
De tweede opdracht gebruikt de cmdlet Out-String om het CultureInfo--object te converteren naar een reeks tekenreeksen (één tekenreeks voor elke eigenschap).
Het gebruikt de parameter InputObject om de variabele $C door te geven aan Out-String.
De parameter Width is ingesteld op 100 tekens per regel om afkapping te voorkomen.
PS C:\> $C = Get-Culture | Select-Object *
PS C:\> Out-String -InputObject $C -Width 100
Met deze opdrachten worden de landinstellingen voor de huidige gebruiker opgehaald en worden de gegevens geconverteerd naar tekenreeksen.
Voorbeeld 3: Werken met objecten
PS C:\> Get-Alias | Out-String -Stream | Select-String "Get-Command"
In dit voorbeeld ziet u het verschil tussen het werken met objecten en het werken met tekenreeksen.
Met de opdracht worden aliassen weergegeven die de woordgroep 'Get-Command' bevatten.
De cmdlet Get-Alias wordt gebruikt om een set AliasInfo--objecten op te halen (één voor elke alias in de huidige sessie).
De pijplijnoperator (|) verzendt de uitvoer van de Get-Alias-cmdlet naar de Out-String-cmdlet, waarmee de objecten worden geconverteerd naar een reeks tekenreeksen.
Hierbij wordt de parameter Stream van Out-String gebruikt om elke tekenreeks afzonderlijk te verzenden, in plaats van ze samen te voegen in één tekenreeks.
Een andere pijplijnoperator verzendt de tekenreeksen naar de Select-String-cmdlet, waarmee de tekenreeksen worden geselecteerd die overal in de tekenreeks 'Get-Command' bevatten.
Als u de parameter Stream weglaat, worden met de opdracht alle aliassen weergegeven, omdat Select-String 'Get-Command' vindt in de enkele tekenreeks die Out-String retourneert en de formatter de tekenreeks als een tabel weergeeft.
Parameters
-InputObject
Hiermee geeft u de objecten die naar een tekenreeks moeten worden geschreven. Voer een variabele in die de objecten bevat of typ een opdracht of expressie waarmee de objecten worden opgehaald.
Parametereigenschappen
| Type: | PSObject |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Stream
Geeft aan dat de cmdlet de tekenreeksen voor elk object afzonderlijk verzendt. Standaard worden de tekenreeksen voor elk object verzameld en verzonden als één tekenreeks.
Als u de parameter Stream wilt gebruiken, typt u -Stream of de alias ost.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Width
Hiermee geeft u het aantal tekens op elke regel van uitvoer. Eventuele extra tekens worden afgekapt, niet verpakt. De parameter Width is alleen van toepassing op objecten die worden opgemaakt. Als u deze parameter weglaat, wordt de breedte bepaald door de kenmerken van het hostprogramma. De standaardwaarde voor de Windows PowerShell-console is 80 (tekens).
Parametereigenschappen
| Type: | Int32 |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.
Invoerwaarden
PSObject
U kunt objecten doorsluisen naar Out-String.
Uitvoerwaarden
String
Out-String retourneert de tekenreeks die wordt gemaakt op basis van het invoerobject.
Notities
- De cmdlets die de Out- werkwoord bevatten die geen objecten opmaken; ze geven ze gewoon weer en verzenden ze naar de opgegeven weergavebestemming. Als u een niet-opgemaakt object naar een out- cmdlet verzendt, verzendt de cmdlet het naar een opmaak-cmdlet voordat het wordt weergegeven.
- De Cmdlets out hebben geen parameters die namen of bestandspaden nemen. Als u gegevens wilt verzenden naar een Out cmdlet, gebruikt u een pijplijnoperator (|) om de uitvoer van een Windows PowerShell-opdracht naar de cmdlet te verzenden. U kunt ook gegevens opslaan in een variabele en de parameter InputObject gebruiken om de gegevens door te geven aan de cmdlet.