How to Use the Command 'Out-String' (with Examples)

The Out-String command in PowerShell is a versatile utility that allows users to convert objects into a string representation. This capability is particularly useful for formatting output data, logging, and displaying object properties in a human-readable format without executing them. It enables users to manipulate and inspect output data easily and is indispensable for those who work with scripts and command-line data processing tasks.

Use Case 1: Print Host Information as String

Code:

Get-Alias | Out-String

Motivation:

When working with PowerShell, sometimes it’s necessary to view all available aliases in a coherent and readable string format, especially when preparing reports or logging outputs for debugging sessions. Get-Alias retrieves a list of defined aliases in the session, which can be extensive, and using Out-String helps in collating this information succinctly. By converting the list into a single string, it becomes easier to handle, share, or append to files.

Explanation:

• Get-Alias: This cmdlet retrieves a list of all aliases in the current PowerShell session. Aliases are shortcuts for longer cmdlet names and aid in faster scripting.
• |: The pipe operator is used to pass the output of Get-Alias directly into the next command.
• Out-String: This cmdlet formats the output into a single string object, making it human-readable rather than being left as a series of separate objects.

Example Output:

CommandType     Name
-----------     ----
Alias           % -> ForEach-Object
Alias           ? -> Where-Object
Alias           cjb -> Clear-Job
...

Use Case 2: Convert Each Object to a String Rather Than Concatenating All the Objects into a Single String

Code:

Get-Alias | Out-String -Stream

Motivation:

There are scenarios when you might need each object converted directly into its string representation rather than having all objects concatenated into a single output string. Using the -Stream parameter is particularly helpful when you intend to process each string-line individually as it becomes available without waiting for all data. This approach is highly effective in real-time logging or when processing outputs line by line in a pipeline.

Explanation:

• Get-Alias: Returns the list of aliases available in the session.
• |: Connects the alias information to the next command.
• Out-String: Converts the output into string format.
• -Stream: This parameter changes the behavior of Out-String so that each object is processed as a separate string output. Instead of forming a cumulative large string, it outputs each object as an individual string, enabling easier and friendlier line-by-line processing.

Example Output:

CommandType
-----------
Alias
...
% -> ForEach-Object
? -> Where-Object
cjb -> Clear-Job
...

Use Case 3: Use the Width Parameter to Prevent Truncation

Code:

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

Motivation:

Long strings or expanded object properties can often be truncated when displayed in the console, which can result in losing critical information. The Width parameter in the Out-String command allows users to specify the maximum number of characters per line, ensuring that the output is displayed without cutting off important details. This feature is beneficial when dealing with expanded data structures or when presenting outputs that require completeness.

Explanation:

• @{TestKey = ('x' * 200)}: Here, a hashtable object with a single key-value pair is created. The value is a string of 200 characters, consisting solely of the letter ‘x’.
• |: Connects this object to the subsequent string conversion.
• Out-String: Formats the object into string form.
• -Width 250: This argument customizes the width of the output, ensuring that longer lines are not truncated. In this example, the width is set to 250 characters, which accommodates the entire length of the ‘x’ string fully.

Example Output:

Name                           Value
----                           -----
TestKey                        xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...

Conclusion:

The Out-String command in PowerShell is highly beneficial for converting objects to strings, letting users visualize and further manipulate console outputs in various formats. Its usage not only aids in smooth data handling but also ensures clarity and precision through parameters like Width and Stream, enhancing the ability to work with long or complex data sets effectively. These illustrative use cases highlight how Out-String plays a critical role in everyday scripting and data management activities.