PowerShell Genie

Out-String

Use Out-String to convert objects into the string form PowerShell would have displayed.

Command 1 min read Windows PowerShell 5.1 and PowerShell 7

Documentation: Microsoft Learn — Out-String

Written and tested by Dhrub Bharali · Updated

Syntax

1PS> Out-String [-Stream] [-Width <Int32>] [-InputObject <PSObject>] [<CommonParameters>]
See the command anatomy

Read the command and its supplied arguments. This example requires real PowerShell or its module; this diagram does not execute it.

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

    Try it

    Windows PowerShell

    PowerShell example · browser support is limited.

    Execution scope: The full example below requires PowerShell outside this browser. You can edit this runner to use the supported practice commands; unsupported syntax returns an explanation.

    Interactive simulation · fictional data

    Examples

    Select first 3

    1PS> Get-Service | Select-Object -First 3 Name, Status | Out-String
    Show reference output

    Sample output · fictional data, shaped like the real thing

    Name      Status
--------  -------
BITS      Running
Dnscache  Running
Spooler   Stopped

    Select first 5

    1PS> Get-Service | Select-Object -First 5 Name | Out-String -Stream | Select-Object -First 3
    Show reference output

    Sample output · fictional data, shaped like the real thing

    Name
--------
BITS
Dnscache
Spooler
WinRM

    Select first 3 (2)

    1PS> $body = Get-Process | Select-Object -First 3 Name, Id | Out-String
    2PS> $body.Length
    Show reference output

    Sample output · fictional data, shaped like the real thing

    Name    Id
------  -----
chrome  9184
Code    6620
pwsh    11268

    Parameters

    Parameter definitions:

    • -Stream
    • -Width
    • -InputObject

    Out-String on Microsoft Learn

    Practical use and troubleshooting

    Practical scenario: Use Out-String when you need to convert objects into the string form PowerShell would have displayed. Review syntax and sample output, then try an example in the browser lab. Start with one identified target and inspect the returned values before extending the operation to a list. Keep the identity in your report so you can trace each result back to the object or path that produced it.

    Common error and fix: An unexpectedly truncated representation can result from display width. Select -Width deliberately for text rendering, but retain original objects for CSV or JSON export. In an unattended script, capture this failure with its original error record and record which target failed. An empty result and an unsuccessful query must remain distinguishable in the final report.

    See also: Out-File. Out-File writes formatted text to a file; Out-String returns a string representation. Use structured formats when later code must reliably read the original properties back. Read the linked command before substituting it; similar names do not imply identical inputs or output.

    Out-String reference on Microsoft Learn

    Recap

    Out-String Use Out-String to convert objects into the string form PowerShell would have displayed.

    Next: ConvertTo-Xml
    Genie guideOut-String

    Use Out-String to convert objects into the string form PowerShell would have displayed. The console below is pre-loaded — run it, then change a value and run it again.

    Explore PowerShell Genie

    Related