Skip to main content

How to use Write-Information

It is always fun to write on a topic that people are passionate about.  Yes, we will be talking about Write-Host in this post.  I know, you either love it or you hate it.

PowerShell uses different “streams” of information.  Here is a quick visual.

Stream |  Definition             | Cmdlet
1      |  Success output         | Write-Output      
2      |  Errors                 | Write-Error       
3      |  Warning messages       | Write-Warning     
4      |  Verbose output         | Write-Verbose     
5      |  Debug messages         | Write-Debug       
6      |  Informational messages | Write-Information 
NA     |  User Experience        | Write-Host         

The above is a little display that I use in class.  Yes, it is created with Write-HostWrite-Host is OK to use if you need to create a user interface of some type.  PowerShell was designed to use the pipeline.  This is stream 1.  Notice that there is no stream for Write-HostWrite-Host sends information directly to the monitor.  There is a stream for Write-Information.

Write-Information became available with PowerShell 5.  Why do we have another cmdlet to put information on the screen? Well, first of all, the end user cannot stop Write-Host from working.  Take a look at this.

PS C:\>     $InformationPreference
SilentlyContinue

The information stream is controlled by a global variable called $InformationPreferenceWrite-Host has no such global variable controlling it.  By default, your information messages are not displayed.

PS C:\> Write-Information -MessageData "Nothing will display"

PS C:\> 

However, you can override this in code.
PS C:\> Write-Information -MessageData "Something will display" -InformationAction Continue
Something will display

The –InformationAction parameter is one of the common parameters.  That means the user running the code can ask for your information messages if they want to see them.  You can also redirect the output of your information stream to another stream if it is appropriate.  You cannot do that with Write-Host because it sends information directory to the screen.  Below is a comparison of the two commands.

Feature
Write-Host
Write-Information
Writes directly to the screen
Yes
No
Can display colors
Yes
No
Can be suppressed by the user
No
Yes
Can be redirected to another stream
No
Yes
Can have TAGs in the metadata
No
Yes
Can be saved in a variable
No
Yes


I understand the draw that Write-Host has with its ability to display colors.  If you are creating a script that requires user interaction, go for it.  If you want code that works well with the pipeline and does not display information on the screen (Which can slow processing times) then consider making the switch to Write-Information.

Comments

Popular posts from this blog

Adding a Comment to a GPO with PowerShell

As I'm writing this article, I'm also writing a customization for a PowerShell course I'm teaching next week in Phoenix.  This customization deals with Group Policy and PowerShell.  For those of you who attend my classes may already know this, but I sit their and try to ask the questions to myself that others may ask as I present the material.  I finished up my customization a few hours ago and then I realized that I did not add in how to put a comment on a GPO.  This is a feature that many Group Policy Administrators may not be aware of. This past summer I attended a presentation at TechEd on Group Policy.  One organization in the crowd had over 5,000 Group Policies.  In an environment like that, the comment section can be priceless.  I always like to write in the comment section why I created the policy so I know its purpose next week after I've completed 50 other tasks and can't remember what I did 5 minutes ago. In the Group Policy module for PowerShell V3, th

Return duplicate values from a collection with PowerShell

If you have a collection of objects and you want to remove any duplicate items, it is fairly simple. # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   # Remove the duplicate values. $Set1 | Select-Object -Unique 1 2 3 4 5 6 7 What if you want only the duplicate values and nothing else? # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   #Create a second collection with duplicate values removed. $Set2 = $Set1 | Select-Object -Unique   # Return only the duplicate values. ( Compare-Object -ReferenceObject $Set2 -DifferenceObject $Set1 ) . InputObject | Select-Object – Unique 1 2 This works with objects as well as numbers.  The first command creates a collection with 2 duplicates of both 1 and 2.   The second command creates another collection with the duplicates filtered out.  The Compare-Object cmdlet will first find items that are diffe

How to list all the AD LDS instances on a server

AD LDS allows you to provide directory services to applications that are free of the confines of Active Directory.  To list all the AD LDS instances on a server, follow this procedure: Log into the server in question Open a command prompt. Type dsdbutil and press Enter Type List Instances and press Enter . You will receive a list of the instance name, both the LDAP and SSL port numbers, the location of the database, and its status.