Adds a separator between the output of each item in an objects or array<\/td><\/tr><\/tbody><\/table>Write-Host CmdLet Parameters<\/figcaption><\/figure>\n\n\n\nBy default, the Write-Host<\/code> cmdlet will output a string on a new line in the console, using the default color of the console (most of the time white):<\/p>\n\n\n\nWrite-Host \"Welcome to the Lazy Script!\"<\/pre>\n\n\n\n
<\/span>Using Colors in Write-Host<\/span><\/h3>\n\n\n\nColors are a great way to attract the user’s attention or tell something about the status non-verbally. For example, yellow text often indicates a warning whereas red text is mostly likely an error. In PowerShell we can assign a color for the text, using the -foregroundcolor<\/code> parameter and a background color for the text with -backgroundcolor<\/code>.<\/p>\n\n\n\nWe can use the following colors for both parameters:<\/p>\n\n\n\n
\nBlack<\/li>\n\n\n\n DarkBlue<\/li>\n\n\n\n DarkGreen<\/li>\n\n\n\n DarkCyan<\/li>\n\n\n\n DarkRed<\/li>\n\n\n\n DarkMagenta<\/li>\n\n\n\n DarkYellow<\/li>\n\n\n\n Gray<\/li>\n\n\n\n DarkGray<\/li>\n\n\n\n Blue<\/li>\n\n\n\n Green<\/li>\n\n\n\n Cyan<\/li>\n\n\n\n Red<\/li>\n\n\n\n Magenta<\/li>\n\n\n\n Yellow<\/li>\n\n\n\n White<\/li>\n<\/ul>\n\n\n\n<\/span>Formatting the Output<\/span><\/h3>\n\n\n\nBy default, each string that is outputted by Write-Host is displayed on a new line. In most cases this is fine, but sometimes you don’t want a new line, or maybe an extra new line between the outputs.<\/p>\n\n\n\n
Let’s first take a look at how to append the results behind the previous Write-Host output. To do this we can use the -NoNewline<\/code> parameter. When added, the next output will append to the existing line:<\/p>\n\n\n\nWrite-Host \"Number of mailboxes: \" -NoNewline\n\n# Get all mailboxes function\n$mailboxes = Get-AllMailboxes\n\nWrite-Host $mailboxes\n\n# Result:\nNumber of mailboxes: 5<\/pre>\n\n\n\nAs you can see, the value $mailboxes<\/code> is appended behind the line “Number of mailboxes”.<\/p>\n\n\n\nIf you want to create an extra new blank line between the outputs, then we can use the `n<\/code> character. This will add an extra new line behind the output of the write-host<\/code> cmdlet:<\/p>\n\n\n\nWrite-Host \"Getting all user mailboxes `n\" -ForegroundColor Cyan\nWrite-Host \"Shared mailboxes found `n `n\" -ForegroundColor Yellow\nWrite-Host \"Script finished\" -ForegroundColor Green<\/pre>\n\n\n\n<\/span>Using Variables inside Write Host<\/span><\/h3>\n\n\n\nGood to know is that we can use variables inside the output of the write-host cmdlet. A simple string variable can be included in the string of write-host when using the double-quotes \" \"<\/code>. Keep in mind that you can’t use variables inside strings wrapped with single-quotes ' '<\/code>. The difference here is that PowerShell only processes strings that are wrapped in double quotes.<\/p>\n\n\n\n$user = \"megan@lazyadmin.nl\"\nWrite-Host \"Getting mailbox of $user\"\n\n# Result\nGetting mailbox of megan@lazyadmin.nl<\/pre>\n\n\n\nBut when working with objects, you might have noticed that you can’t output the items of an object. For example, this won’t<\/strong> work:<\/p>\n\n\n\n$user = [PSCustomObject]@{\n DisplayName = \"Megan\"\n Email = \"megan@lazyadmin.nl\"\n}\n\nWrite-Host \"Getting mailbox of $user.displayname\"<\/pre>\n\n\n\nTo show the display name of the user object, we will need to wrap it in parentheses, like this:<\/p>\n\n\n\n
$user = [PSCustomObject]@{\n DisplayName = \"Megan\"\n Email = \"megan@lazyadmin.nl\"\n}\n\nWrite-Host \"Getting mailbox of $($user.DisplayName)\"\n\n# Result\nGetting mailbox of Megan<\/pre>\n\n\n\n<\/span>Using a Separator<\/span><\/h3>\n\n\n\nWhen you want to output the results of an array to the console, then the results will be displayed on a single row by default. For example, I have a CSV file with some fruits. When we import the CSV file and output the result then it will be formatted like this:<\/p>\n\n\n\n
$example = import-csv -path C:\\temp\\example.csv -Header Fruit\nWrite-Host $example.fruit\n\n# Result\nApple Banana Pear Kiwi Raspberry Melon<\/pre>\n\n\n\nTo show each fruit on its own line or separate each fruit with a character, we can use the -Separator<\/code> parameter:<\/p>\n\n\n\n# Show results on a new line\n$example = import-csv -path C:\\temp\\example.csv -Header Fruit\nWrite-Host $example.fruit -Separator \"`n\"\n\n# Result\nApple\nBanana\nPear\nKiwi\nRaspberry\nMelon\n\n# Separate results with a space and dash\n$example = import-csv -path C:\\temp\\example.csv -Header Fruit\nWrite-Host $example.fruit -Separator \" - \"\n\n# Result\nApple - Banana - Pear - Kiwi - Raspberry - Melon<\/pre>\n\n\n\n<\/span>Write Host Formatting Examples<\/span><\/h3>\n\n\n\nWith some creativity, you can create different banners, or alerts in your scripts that really stand out. Below I gather a couple of examples as inspirations for you. If you have other good examples, please share them in the comments below!<\/p>\n\n\n\n
Adding a new line above and below a warning message, adding some space around the message, and using a background color can really make a message stand out:<\/p>\n\n\n\n
\n
Write-Host \"`n\"\nWrite-Host \" RUNNING IN TEST MODE \" -BackgroundColor Yellow -ForegroundColor Black\nWrite-Host \"`n\"<\/pre>\n\n\n\nScript banners are always a bit of a puzzle to get right. In the code example below it doesn’t look aligned, but when using it in a script you will see a perfect banner.<\/p>\n\n\n\n
\n
Write-Host \"`n\"\nWrite-Host \" ------------------------------------------------- \" -ForegroundColor Cyan\nWrite-Host \" | |\t\t\t\t\t\t\" -ForegroundColor Cyan\nWrite-Host \" | Create new AD User |\t\t\t\t\t\t\" -ForegroundColor Cyan\nWrite-Host \" | Version 1.7 |\t\t\t\t\t\t\" -ForegroundColor Cyan\nWrite-Host \" | |\t\t\t\t\t\t\" -ForegroundColor Cyan\nWrite-Host \" | Author R. Mens - LazyAdmin.nl |\t\t\t\t\t\t\" -ForegroundColor Cyan\nWrite-Host \" | |\t\t\t\t\t\t\" -ForegroundColor Cyan\nWrite-Host \" ------------------------------------------------- \" -ForegroundColor Cyan\nWrite-Host \"`n\"<\/pre>\n\n\n\nWe can also do something fun with the foreground colors and some ASCII art. The code below divides the position of each character with 6. Depending on the result, it will assign a color to the character. By using the -NoNewline<\/code> parameter we can append the results:<\/p>\n\n\n\n$text = \"\n _ ___ _ _ \n| | \/ _ \\ | | (_) \n| | __ _ _____ _\/ \/_\\ \\ __| |_ __ ___ _ _ __ \n| | \/ _ |_ \/ | | | _ |\/ _ | '_ _ \\| | '_ \\ \n| |___| (_| |\/ \/| |_| | | | | (_| | | | | | | | | | |\n\\_____\/\\__,_\/___|\\__, \\_| |_\/\\__,_|_| |_| |_|_|_| |_|\n __\/ | \n |___\/ \"\n\n\nfor ($i=0; $i -lt $text.length; $i++) {\n switch ($i % 6) {\n 0 { $c = \"white\" }\n 2 { $c = \"green\" }\n 4 { $c = \"blue\" }\n default { $c = \"cyan\" }\n }\nwrite-host $text[$i] -NoNewline -ForegroundColor $c\n}<\/pre>\n\n\n\n<\/span>Wrapping Up<\/span><\/h2>\n\n\n\nThe Write-Host cmdlet is a great way to keep the user of your script informed about the progress of your scripts. It can give instructions to the user, show the results, or simply inform the user when the script is completed or runs into an error.<\/p>\n\n\n\n
Make good use of the foreground colors, because they really help with quickly identifying the meaning of a message.<\/p>\n\n\n\n
I hope you like this article, if you have any questions, just drop a comment below!<\/p>\n