(AB-538621) Extend Write-Host note for non-primitive types

Author: michaeltlombardi

reference/5.1/Microsoft.PowerShell.Utility/Write-Host.md

@@ -2,7 +2,7 @@
 external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
 Locale: en-US
 Module Name: Microsoft.PowerShell.Utility
-ms.date: 09/26/2023
+ms.date: 04/01/2026
 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/write-host?view=powershell-5.1&WT.mc_id=ps-gethelp
 schema: 2.0.0
 title: Write-Host
@@ -24,18 +24,17 @@ Write-Host [[-Object] <Object>] [-NoNewline] [-Separator <Object>] [-ForegroundC
 ## DESCRIPTION
 
 The `Write-Host` cmdlet's primary purpose is to produce for-(host)-display-only output, such as
-printing colored text like when prompting the user for input in conjunction with
-[Read-Host](Read-Host.md). `Write-Host` uses the [ToString()](/dotnet/api/system.object.tostring)
-method to write the output. By contrast, to output data to the pipeline, use
-[Write-Output](Write-Output.md) or implicit output.
+printing colored text like when prompting the user for input in conjunction with [Read-Host][01].
+`Write-Host` uses the [ToString()][02] method to write the output. By contrast, to output data to
+the pipeline, use [Write-Output][03] or implicit output.
 
 You can specify the color of text by using the `ForegroundColor` parameter, and you can specify the
 background color by using the `BackgroundColor` parameter. The Separator parameter lets you specify
 a string to use to separate displayed objects. The particular result depends on the program that is
 hosting PowerShell.
 
 > [!NOTE]
-> Starting in Windows PowerShell 5.0, `Write-Host` is a wrapper for `Write-Information` This allows
+> Starting in Windows PowerShell 5.0, `Write-Host` is a wrapper for `Write-Information`. This allows
 > you to use `Write-Host` to emit output to the information stream. This enables the **capture** or
 > **suppression** of data written using `Write-Host` while preserving backwards compatibility.
 >
@@ -113,8 +112,7 @@ Write-Host "I won't print" 6> $null
 These commands effectively suppress output of the `Write-Host` cmdlet. The first one uses the
 `InformationAction` parameter with the `Ignore` Value to suppress output to the information stream.
 The second example redirects the information stream of the command to the `$null` variable and
-thereby suppresses it. For more information, see
-[about_Output_Streams](../Microsoft.PowerShell.Core/About/about_Output_Streams.md).
+thereby suppresses it. For more information, see [about_Output_Streams][04].
 
 ## PARAMETERS
 
@@ -261,23 +259,54 @@ cmdlet sends to it.
   separated by a single space. This can be overridden with the **Separator** parameter.
 
 - Non-primitive data types such as objects with properties can cause unexpected results and not
-  provide meaningful output. For example, `Write-Host @{a = 1; b = 2}` will print
-  `System.Collections.DictionaryEntry System.Collections.DictionaryEntry` to the host.
+  provide meaningful output. For example, `@{a = 1; b = 2} | Write-Host` will print
+  `System.Collections.HashTable` to the host.
+
+  To work around this issue, you can manually create the string format you need with either
+  [string interpolation][05] or the [format operator][06]. You can also pass the object to the
+  [Out-String][07] command before passing it to `Write-Host`. The following snippet shows examples
+  of each approach:
+
+  ```powershell
+  $ht = @{a = 1; b = 2}
+  # String interpolation
+  $ht.Keys.ForEach({ "[$_, $($ht[$_])]" }) -join ' ' | Write-Host
+  # Format operator
+  "[{0}, {1}] [{2}, {3}]" -f @('a', $ht.a, 'b', $ht.b) | Write-Host
+  # Out-String
+  $ht | Out-String | Write-Host
+  ```
 
 ## RELATED LINKS
 
-[Clear-Host](../Microsoft.PowerShell.Core/Clear-Host.md)
+[Clear-Host][08]
 
-[Out-Host](../Microsoft.PowerShell.Core/Out-Host.md)
+[Out-Host][09]
 
-[Write-Debug](Write-Debug.md)
+[Write-Debug][10]
 
-[Write-Error](Write-Error.md)
+[Write-Error][11]
 
-[Write-Output](Write-Output.md)
+[Write-Output][03]
 
-[Write-Progress](Write-Progress.md)
+[Write-Progress][12]
 
-[Write-Verbose](Write-Verbose.md)
+[Write-Verbose][13]
 
-[Write-Warning](Write-Warning.md)
+[Write-Warning][14]
+
+<!-- Link reference definitions -->
+[01]: Read-Host.md
+[02]: /dotnet/api/system.object.tostring
+[03]: Write-Output.md
+[04]: ../Microsoft.PowerShell.Core/About/about_Output_Streams.md
+[05]: /powershell/scripting/learn/deep-dives/everything-about-string-substitutions
+[06]: ../Microsoft.PowerShell.Core/About/about_Operators.md#format-operator--f
+[07]: Out-String.md
+[08]: ../Microsoft.PowerShell.Core/Clear-Host.md
+[09]: ../Microsoft.PowerShell.Core/Out-Host.md
+[10]: Write-Debug.md
+[11]: Write-Error.md
+[12]: Write-Progress.md
+[13]: Write-Verbose.md
+[14]: Write-Warning.md

reference/7.4/Microsoft.PowerShell.Utility/Write-Host.md

@@ -2,7 +2,7 @@
 external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
 Locale: en-US
 Module Name: Microsoft.PowerShell.Utility
-ms.date: 09/26/2023
+ms.date: 04/01/2026
 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/write-host?view=powershell-7.4&WT.mc_id=ps-gethelp
 schema: 2.0.0
 title: Write-Host
@@ -24,10 +24,9 @@ Write-Host [[-Object] <Object>] [-NoNewline] [-Separator <Object>] [-ForegroundC
 ## DESCRIPTION
 
 The `Write-Host` cmdlet's primary purpose is to produce for-(host)-display-only output, such as
-printing colored text like when prompting the user for input in conjunction with
-[Read-Host](Read-Host.md). `Write-Host` uses the [ToString()](/dotnet/api/system.object.tostring)
-method to write the output. By contrast, to output data to the pipeline, use
-[Write-Output](Write-Output.md) or implicit output.
+printing colored text like when prompting the user for input in conjunction with [Read-Host][01].
+`Write-Host` uses the [ToString()][02] method to write the output. By contrast, to output data to
+the pipeline, use [Write-Output][03] or implicit output.
 
 You can specify the color of text by using the `ForegroundColor` parameter, and you can specify the
 background color by using the `BackgroundColor` parameter. The Separator parameter lets you specify
@@ -113,8 +112,7 @@ Write-Host "I won't print" 6> $null
 These commands effectively suppress output of the `Write-Host` cmdlet. The first one uses the
 `InformationAction` parameter with the `Ignore` Value to suppress output to the information stream.
 The second example redirects the information stream of the command to the `$null` variable and
-thereby suppresses it. For more information, see
-[about_Output_Streams](../Microsoft.PowerShell.Core/About/about_Output_Streams.md).
+thereby suppresses it. For more information, see [about_Output_Streams][04].
 
 ## PARAMETERS
 
@@ -261,23 +259,54 @@ cmdlet sends to it.
   separated by a single space. This can be overridden with the **Separator** parameter.
 
 - Non-primitive data types such as objects with properties can cause unexpected results and not
-  provide meaningful output. For example, `Write-Host @{a = 1; b = 2}` will print
-  `System.Collections.DictionaryEntry System.Collections.DictionaryEntry` to the host.
+  provide meaningful output. For example, `@{a = 1; b = 2} | Write-Host` will print
+  `System.Collections.HashTable` to the host.
+
+  To work around this issue, you can manually create the string format you need with either
+  [string interpolation][05] or the [format operator][06]. You can also pass the object to the
+  [Out-String][07] command before passing it to `Write-Host`. The following snippet shows examples
+  of each approach:
+
+  ```powershell
+  $ht = @{a = 1; b = 2}
+  # String interpolation
+  $ht.Keys.ForEach({ "[$_, $($ht[$_])]" }) -join ' ' | Write-Host
+  # Format operator
+  "[{0}, {1}] [{2}, {3}]" -f @('a', $ht.a, 'b', $ht.b) | Write-Host
+  # Out-String
+  $ht | Out-String | Write-Host
+  ```
 
 ## RELATED LINKS
 
-[Clear-Host](../Microsoft.PowerShell.Core/Clear-Host.md)
+[Clear-Host][08]
 
-[Out-Host](../Microsoft.PowerShell.Core/Out-Host.md)
+[Out-Host][09]
 
-[Write-Debug](Write-Debug.md)
+[Write-Debug][10]
 
-[Write-Error](Write-Error.md)
+[Write-Error][11]
 
-[Write-Output](Write-Output.md)
+[Write-Output][03]
 
-[Write-Progress](Write-Progress.md)
+[Write-Progress][12]
 
-[Write-Verbose](Write-Verbose.md)
+[Write-Verbose][13]
 
-[Write-Warning](Write-Warning.md)
+[Write-Warning][14]
+
+<!-- Link reference definitions -->
+[01]: Read-Host.md
+[02]: /dotnet/api/system.object.tostring
+[03]: Write-Output.md
+[04]: ../Microsoft.PowerShell.Core/About/about_Output_Streams.md
+[05]: /powershell/scripting/learn/deep-dives/everything-about-string-substitutions
+[06]: ../Microsoft.PowerShell.Core/About/about_Operators.md#format-operator--f
+[07]: Out-String.md
+[08]: ../Microsoft.PowerShell.Core/Clear-Host.md
+[09]: ../Microsoft.PowerShell.Core/Out-Host.md
+[10]: Write-Debug.md
+[11]: Write-Error.md
+[12]: Write-Progress.md
+[13]: Write-Verbose.md
+[14]: Write-Warning.md

reference/7.5/Microsoft.PowerShell.Utility/Write-Host.md

@@ -2,7 +2,7 @@
 external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
 Locale: en-US
 Module Name: Microsoft.PowerShell.Utility
-ms.date: 09/26/2023
+ms.date: 04/01/2026
 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/write-host?view=powershell-7.5&WT.mc_id=ps-gethelp
 schema: 2.0.0
 title: Write-Host
@@ -24,18 +24,17 @@ Write-Host [[-Object] <Object>] [-NoNewline] [-Separator <Object>] [-ForegroundC
 ## DESCRIPTION
 
 The `Write-Host` cmdlet's primary purpose is to produce for-(host)-display-only output, such as
-printing colored text like when prompting the user for input in conjunction with
-[Read-Host](Read-Host.md). `Write-Host` uses the [ToString()](/dotnet/api/system.object.tostring)
-method to write the output. By contrast, to output data to the pipeline, use
-[Write-Output](Write-Output.md) or implicit output.
+printing colored text like when prompting the user for input in conjunction with [Read-Host][01].
+`Write-Host` uses the [ToString()][02] method to write the output. By contrast, to output data to
+the pipeline, use [Write-Output][03] or implicit output.
 
 You can specify the color of text by using the `ForegroundColor` parameter, and you can specify the
 background color by using the `BackgroundColor` parameter. The Separator parameter lets you specify
 a string to use to separate displayed objects. The particular result depends on the program that is
 hosting PowerShell.
 
 > [!NOTE]
-> Starting in Windows PowerShell 5.0, `Write-Host` is a wrapper for `Write-Information` This allows
+> Starting in Windows PowerShell 5.0, `Write-Host` is a wrapper for `Write-Information`. This allows
 > you to use `Write-Host` to emit output to the information stream. This enables the **capture** or
 > **suppression** of data written using `Write-Host` while preserving backwards compatibility.
 >
@@ -113,8 +112,7 @@ Write-Host "I won't print" 6> $null
 These commands effectively suppress output of the `Write-Host` cmdlet. The first one uses the
 `InformationAction` parameter with the `Ignore` Value to suppress output to the information stream.
 The second example redirects the information stream of the command to the `$null` variable and
-thereby suppresses it. For more information, see
-[about_Output_Streams](../Microsoft.PowerShell.Core/About/about_Output_Streams.md).
+thereby suppresses it. For more information, see [about_Output_Streams][04].
 
 ## PARAMETERS
 
@@ -261,23 +259,54 @@ cmdlet sends to it.
   separated by a single space. This can be overridden with the **Separator** parameter.
 
 - Non-primitive data types such as objects with properties can cause unexpected results and not
-  provide meaningful output. For example, `Write-Host @{a = 1; b = 2}` will print
-  `System.Collections.DictionaryEntry System.Collections.DictionaryEntry` to the host.
+  provide meaningful output. For example, `@{a = 1; b = 2} | Write-Host` will print
+  `System.Collections.HashTable` to the host.
+
+  To work around this issue, you can manually create the string format you need with either
+  [string interpolation][05] or the [format operator][06]. You can also pass the object to the
+  [Out-String][07] command before passing it to `Write-Host`. The following snippet shows examples
+  of each approach:
+
+  ```powershell
+  $ht = @{a = 1; b = 2}
+  # String interpolation
+  $ht.Keys.ForEach({ "[$_, $($ht[$_])]" }) -join ' ' | Write-Host
+  # Format operator
+  "[{0}, {1}] [{2}, {3}]" -f @('a', $ht.a, 'b', $ht.b) | Write-Host
+  # Out-String
+  $ht | Out-String | Write-Host
+  ```
 
 ## RELATED LINKS
 
-[Clear-Host](../Microsoft.PowerShell.Core/Clear-Host.md)
+[Clear-Host][08]
 
-[Out-Host](../Microsoft.PowerShell.Core/Out-Host.md)
+[Out-Host][09]
 
-[Write-Debug](Write-Debug.md)
+[Write-Debug][10]
 
-[Write-Error](Write-Error.md)
+[Write-Error][11]
 
-[Write-Output](Write-Output.md)
+[Write-Output][03]
 
-[Write-Progress](Write-Progress.md)
+[Write-Progress][12]
 
-[Write-Verbose](Write-Verbose.md)
+[Write-Verbose][13]
 
-[Write-Warning](Write-Warning.md)
+[Write-Warning][14]
+
+<!-- Link reference definitions -->
+[01]: Read-Host.md
+[02]: /dotnet/api/system.object.tostring
+[03]: Write-Output.md
+[04]: ../Microsoft.PowerShell.Core/About/about_Output_Streams.md
+[05]: /powershell/scripting/learn/deep-dives/everything-about-string-substitutions
+[06]: ../Microsoft.PowerShell.Core/About/about_Operators.md#format-operator--f
+[07]: Out-String.md
+[08]: ../Microsoft.PowerShell.Core/Clear-Host.md
+[09]: ../Microsoft.PowerShell.Core/Out-Host.md
+[10]: Write-Debug.md
+[11]: Write-Error.md
+[12]: Write-Progress.md
+[13]: Write-Verbose.md
+[14]: Write-Warning.md