{"id":92902,"date":"2021-11-24T15:56:03","date_gmt":"2021-11-24T15:56:03","guid":{"rendered":"https:\/\/www.red-gate.com\/simple-talk\/?p=92902"},"modified":"2021-11-24T15:56:03","modified_gmt":"2021-11-24T15:56:03","slug":"working-with-powershell-strings","status":"publish","type":"post","link":"https:\/\/www.red-gate.com\/simple-talk\/sysadmin\/powershell\/working-with-powershell-strings\/","title":{"rendered":"Working with PowerShell strings"},"content":{"rendered":"

One of the things that I\u2019ve both appreciated about PowerShell but also been at times confused by PowerShell is its concepts of strings and variables. This article explains what you need to know when working with PowerShell strings.<\/p>\n

For example, when you start writing in PowerShell, you may notice that you can use single quotes or double quotes to designate a string.<\/p>\n

Starting simple<\/h2>\n
\"A very simple string.\"\r\n$string1 = \"This is a string variable.\"\r\n$string2 = 'This is also a string variable.'\r\n$string1, $string2\r\nwrite-host $string1, $string2\r\nwrite-host $string1 $string2<\/pre>\n
Save the above as SimpleStrings_demo.ps1<\/em>. And as usual, examples are available at Github<\/a>.<\/p>\n
When you run the above, you will see the following output:<\/p>\n
\"Image<\/p>\n
The first line is echoed as is because you haven\u2019t told PowerShell to do anything special.<\/p>\n
Then you have created two variables and assigned strings to them. Again, in the case where there\u2019s no assignment and no cmdlet used, PowerShell simply echos out the contents of the variables, one to a line.<\/p>\n
When you use the write-host variable, PowerShell will again write them out, but this time keep them on the same line. It doesn\u2019t matter here if you use a comma or not to separate them.<\/p>\n
So far, the strings with double quotes and single quotes act the same way. But there is a difference which you\u2019ll see in the following example:<\/p>\n
$name = \"Greg\"\r\n$age = 53\r\n\"My name is $name and my age is $age.\"\r\n$string1 = \"DQ: My name is $name and my age is $age.\"\r\n$string2 = 'SQ: My name is $name and my age is $age.'\r\nwrite-host $string1\r\nwrite-host $string2\r\n <\/pre>\n
Save the above as SimpleStrings_with_variables_demo.ps1<\/em> and run it.<\/p>\n
Your output will look like:<\/p>\n
\"Image<\/p>\n
You will immediately notice that in the case of the double quotes, PowerShell did replace the inline variables of $name<\/code> and $age<\/code> with their values. However, in the case of single quotes, it treated the variables as part of the string itself and did not replace them.<\/p>\n
The upside is that it\u2019s very easy to write out strings with the value of the variables embedded directly in the string. The downside is that you can\u2019t easily print out the variable’s name, which you may want to do while debugging a script.<\/p>\n
The following example, SimpleStrings_with_variables_demo_2.ps1<\/em> shows a few ways of solving that problem:<\/p>\n
$name = \"Greg\"\r\n$age = 53\r\n\"My name is $name and my age is $age.\"\r\n$string1 = \"The `$name value is $name and the `$age value is $age.\"\r\n$string2 = 'The $name value is ' + $name + ' and the $age value is ' + $age\r\n$string3 = 'The $name value is ' + $name + \" and the `$age value is $age\"\r\nwrite-host $string1\r\nwrite-host $string2\r\nwrite-host $string3<\/pre>\n
\"Image<\/p>\n
You will notice the backtick character ` allows you to escape the $ so that PowerShell does not treat the characters that follow as a variable name. That is generally the way I do it.<\/p>\n
You may be tempted, and it\u2019s perfectly legal, to build a string as shown in $string2<\/code>, however, I find that harder to read and more complex and see no value to it. $string3<\/code> is simply an example showing you can use both single-quoted strings and double-quoted strings when building up a larger string. However, I would definitely avoid that one.<\/p>\n
Dealing with objects<\/h2>\n
You will often find yourself dealing with objects when working with PowerShell. Dealing with objects introduces an issue, but fortunately, like most things, PowerShell has a solution. The following examples can be found in the Github repository in the file Strings_with_object.ps1.<\/code><\/p>\n
Start by creating an object. For the purposes of this demo, it will be a simple instantiation and assignment.<\/p>\n
$person1= @{Name='Greg' \r\nAge=53} <\/pre>\n
This object has two properties: a name and an age. Again if you simply hand the object to PowerShell and execute it, PowerShell will print something out, but a bit differently from the above examples.<\/p>\n
Pass $person1<\/code> to PowerShell and hit enter, and you should see something like:<\/p>\n
\"Image<\/p>\n
This method is not terrible, but also not terribly useful. However, if you try to use the write-host cmdlet as follows: write-host $person1<\/code>, you don\u2019t get what you might expect. Instead, you get the curious response of:<\/p>\n
\"Image<\/p>\n
That\u2019s not overly helpful. If you try to put the object in between double quotes (since you know with single quotes, it will simply print out what it is handed), you will get the following:<\/p>\n
write-host \"This is all about $person1\" <\/pre>\n
\"Image<\/p>\n
Note the difference in the two responses. In the first case, PowerShell is attempting to parse the object and determine two properties within the object. In the second case, PowerShell doesn\u2019t do any parsing but simply determines it is a hashtable.<\/p>\n
The above responses provide the clues you need to get what you want. But before you get there, try the following:<\/p>\n
$person1.Name, $person1.Age <\/pre>\n
You will get:<\/p>\n
\"Image<\/p>\n
This result makes sense because now you are specifying which property you want, but it\u2019s still far from perfect.<\/p>\n
You may try the following, which seems like it should work:<\/p>\n
write-host \"This is all about $person1.Name\" <\/pre>\n
But, curiously, this fails with the following:<\/p>\n
\"Image<\/p>\n
Note that this message is a bit different from the above one that mentioned this being a Hashtable. It has .Name<\/code> appended to the end. It appears that PowerShell is correctly trying to expand the object, but it\u2019s ignoring your reference to a specific property.<\/p>\n
The solution here is to force PowerShell to evaluate the entire object before it gets to Write-Host<\/code>.<\/p>\n
You may be tempted to try the following:<\/p>\n
# A work around\r\n$personName = $person1.Name\r\nwrite-host \"This is all about $personName\" <\/pre>\n
Executing this will work:<\/p>\n
\"image<\/p>\n
But, it\u2019s wordy and, in my opinion, a bit messy. Imagine you had an object with a dozen or more properties you wanted to write out.<\/p>\n
The solution is to take advantage of scoping and to use parentheses as follows:<\/p>\n
write-host \"This is all about $($person1.Name) who is $($person1.Age)\" <\/pre>\n
This code will return:<\/p>\n
\"Image<\/p>\n
This result is most likely what you wanted. PowerShell starts with the object inside the parentheses (e.g. $person1.Name<\/code>) and evaluates that, and then treats it as a variable denoted by the outer $. Write-host then evaluates that variable and inserts it into the string.<\/p>\n
Note this means you can do some additional fancy things such as the following<\/p>\n
$person2 = @{Name=\"Joe\"\r\nAge=78}\r\nwrite-host \"Together $($person1.Name) and $($person2.Name) are a total of $($person1.Age + $person2.Age) years old.\" <\/pre>\n
This will produce:<\/p>\n
\"Image<\/p>\n
The summation of the ages of $person1<\/code> and $person2<\/code> happens before Write-host<\/code> evaluates the outer $.<\/p>\n
Formatting strings<\/h2>\n
Imagine you are tasked with using PowerShell to print out invoices from an order management system. With your newfound knowledge, you sit down and write something like:<\/p>\n
$cost = 144.56\r\n$quantity = 11\r\nWrite-host \"Your cost for $quantity will be: $($cost*$quantity)\" <\/pre>\n
Your output looks like:<\/p>\n
\"Image<\/p>\n
It\u2019s not quite perfect. You\u2019d really like to include a currency character to the string, but you can come back to that later.<\/p>\n
The more immediate issue is that when $quantity = 10<\/code>. Then you get the following:<\/p>\n
\"\"<\/p>\n
Note the missing trailing 0.<\/p>\n
This problem is fortunately easy to fix. PowerShell strings allow formatting using .NET standards.<\/p>\n
One simple way of fixing the above is the code below:<\/p>\n
$formatted = \"Your cost for {0} will be: {1:f2}\" -f $quantity, $($quantity*$cost)\r\nwrite-host $formatted <\/pre>\n
This will print:<\/p>\n
\"\"<\/p>\n
That\u2019s an improvement. The f2<\/code> is an instruction to return 2 floating-point values after the period. Additionally, you may want to put a currency symbol in there and a comma.<\/p>\n
A simple fix would simply to do the following:<\/p>\n
$formatted = \"Your cost for {0} will be: `${1:n2}\" -f $quantity, $($quantity*$cost)\r\nwrite-host $formatted <\/pre>\n
\"Image<\/p>\n
Note two essential parts here. The dollar sign was added with a backtick ` so PowerShell doesn\u2019t interpret it as the start of a variable name. In addition, by changing the f<\/code> to n<\/code>, PowerShell will treat this as a number using a cultural separator. This code will work equally well in a machine set up in Europe, where they tend to reverse the use of the period and comma separators. However, the currency character is still an issue which can be fixed with slightly different formatting:<\/p>\n
$formatted = \"Your cost for {0} will be: {1:c2}\" -f $quantity, $($quantity*$cost)\r\nwrite-host $formatted <\/pre>\n
\"Image<\/p>\n
Note that the $<\/code> is no longer needed as part of the string.<\/p>\n
PowerShell isn\u2019t just limited to formatting currency; you can use it for other formats. For example, say you needed to generate a list of User IDs with a specific format:<\/p>\n
1..15 | % { 'UserID_{0:d4}' -f $_ } <\/pre>\n
The above will generate 15 User IDs of the format:<\/p>\n
\"Image<\/p>\n
A common requirement is formatting dates. There\u2019s a couple of ways of doing this. If you do nothing and simply accept the defaults as follows:<\/p>\n
$exampledate = get-date\r\nwrite-host $exampledate <\/pre>\n
The results depend on your regional settings. In the US, you will get:<\/p>\n
\"Image<\/p>\n
You could format the date when you create it:<\/p>\n
$fdate = get-date -Format \"yyyy-MM-dd\"\r\nwrite-host $fdate <\/pre>\n
This will return:<\/p>\n
\"Image<\/p>\n
Unfortunately, the variable $fdate<\/code> contains only the information shown. You can\u2019t later reference the time if you want.<\/p>\n
However, there are a lot of built-in formats available:<\/p>\n
$fdate = get-date -Format \"R\"\r\nwrite-host $fdate <\/pre>\n
This method returns:<\/p>\n
\"Image<\/p>\n
If you want to store the full value of the returned date and later use only a formatted portion of it, you can do something like the following:<\/p>\n
write-host $exampledate.ToString('yyyy-MM-dd')\r\nWrite-Host $exampledate.ToString(\"hh:mm:ss\")<\/pre>\n
As you can see, there are plenty of ways to format your strings, dates, and other variables.<\/p>\n
String padding and trimming<\/h2>\n
Often you may find yourself wanting to pad out or trim a string. You may want items to appear clearly in columns on the screen, or you may write to a file with fixed-length fields.<\/p>\n
This task can be easily handled, as seen in the examples below. Save these as String_Padding_and_Trimming.ps1.<\/em><\/p>\n
First, you need to generate some strings. Note that while the first variable claims to have three characters, it actually has a trailing space. This might go unnoticed in some cases if the value was read in from a database field.<\/p>\n
$3char = \"123 \"  # note space!\r\n$4char = \"4567\"\r\nwrite-host $3char\r\nWrite-Host $4char<\/pre>\n
This looks perfectly fine as is:<\/p>\n
\"Image<\/p>\n
# But what if we want them to line up, and we expect someday we might even have longer strings.\r\n$padamount = 5\r\n$padcharacter = ' '\r\nwrite-host $3char.PadLeft($padamount,$padcharacter)\r\nWrite-Host $4char.PadLeft($padamount,$padcharacter)<\/pre>\n
This now almost works, but that trailing space is obvious:<\/p>\n
\"Image<\/p>\n
Fortunately, this is fairly easy to fix using the trim()<\/code> method:<\/p>\n
write-host $3char.trim().PadLeft($padamount,$padcharacter)\r\nWrite-Host $4char.PadLeft($padamount,$padcharacter) <\/pre>\n
\"Image<\/p>\n
You can also pad to the right and, of course, select other characters. Again notice the trailing space is an issue, so in the second example, you can eliminate it.<\/p>\n
$padamount = 7\r\n$padcharacter = '.'\r\nwrite-host $3char.PadRight($padamount,$padcharacter)\r\nWrite-Host $4char.PadRight($padamount,$padcharacter)<\/pre>\n
\"Image<\/p>\n
write-host $3char.trim().PadRight($padamount,$padcharacter)\r\nWrite-Host $4char.PadRight($padamount,$padcharacter) <\/pre>\n
<\/p>\n
You can do a lot more with the Pad and Trim methods once you fully understand them.<\/p>\n
Adding some color to your life<\/h2>\n
Finally, what is life without some color, or, in this case, showing strings with color?<\/p>\n
Like most things, PowerShell makes this very easy. Below is a script that was possibly written by a Hobbit to keep track of something near and dear to their stomach.<\/p>\n
Save the following script as String_Color.ps1.<\/em><\/p>\n
$tod = get-date\r\nif ($tod.Hour -ge 6 -and $tod.Hour -lt 9)\r\n    {\r\n        write-host \"Time for Breakfast!\" -ForegroundColor Yellow\r\n    }\r\nelseif ($tod.Hour -ge 9 -and $tod.Hour -lt 11)\r\n    {\r\n        write-host \"Time for 2nd Breakfast!\" -ForegroundColor Red -BackgroundColor Green\r\n        write-host \"That's only if he knows about second breakfast!\"           \r\n    }    \r\nelseif ($tod.Hour -ge 11 -and $tod.Hour -lt 12)\r\n    {\r\n        write-host \"Elevenses!\" -BackgroundColor Red\r\n    }    \r\nelseif ($tod.Hour -ge 12 -and $tod.Hour -lt 14)\r\n    {\r\n        write-host \"Luncheon\" -ForegroundColor Red -BackgroundColor Yellow\r\n    }\r\nelse\r\n    {\r\n        Write-host \"Afternoon Tea - 2:00 PM until 5:00 PM \" -ForegroundColor Black -BackgroundColor DarkRed -NoNewline\r\n        Write-host \"Dinner - 7:00 PM until 9:00 PM \" -ForegroundColor Red -BackgroundColor DarkBlue -NoNewline\r\n        Write-host \"Supper - 9:00 PM until 11:00 PM \" -ForegroundColor Red -BackgroundColor DarkGreen\r\n    } \r\n     <\/pre>\n
The above script will help any Hobbit keep track of what meal they should be planning for. Note that portion control in case 12 dwarves show up unexpectedly is not covered.<\/p>\n
If it\u2019s early in the day, the script will simply change the foreground color of the text to yellow. This color change is done merely by adding the \u2013foreground parameter to write-host.<\/p>\n
In the case of second breakfast, you can set both the foreground and background colors as you desire. You will also note that any color you set is only in effect for that particular write-host cmdlet. The following one will revert back to the host colors in your terminal or IDE.<\/p>\n
You can, as demonstrated with Elevenses, set only the background color.<\/p>\n
Finally, if you want to have multiple colors on the same line, you can take advantage of the \u2013NoNewLine parameter for Write-Host and suppress adding a newline character to your output. This technique can be useful if you want to build a menu option such as below: (save as Select_Option_With_Color.ps1<\/em>)<\/p>\n
write-host \"1) \" -ForegroundColor Red -NoNewline\r\nwrite-host \"select Option 1\" -ForegroundColor Yellow\r\nwrite-host \"2) \" -ForegroundColor Red -NoNewline\r\nwrite-host \"select Option 2\" -ForegroundColor Yellow\r\nwrite-host \"3) \" -ForegroundColor Red -NoNewline\r\nwrite-host \"select Option 3\" -ForegroundColor Yellow\r\n$result = Read-host \"Select an option above\"\r\nif ($result -ge 1 -and $result -le 3)\r\n    { Write-host \"Thank you for selecting $result\" }\r\nelse\r\n    { \"You selected an invalid value $result\" }\r\n <\/pre>\n
PowerShell strings<\/h2>\n
In general, string handling in PowerShell is quite simple, but minor differences such as using double quotes or single quotes can make a difference. In addition, knowing how to escape a character or force the evaluation of a variable inside a string can make life simpler as you don\u2019t need to add additional steps before you can output your string.<\/p>\n
Additionally, most of the string operations shown in the article can be used when outputting to a file, making the creation of a CSV or file based on length delimited columns far easier to create.<\/p>\n
If you like this article, you might also like\u00a0PowerShell editors and environments part 2.<\/a><\/em><\/p>\n","protected":false},"excerpt":{"rendered":"
Knowing how to manipulate strings is critical in any language. In this article, Greg Moore explains working with PowerShell strings.…<\/p>\n","protected":false},"author":319367,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[53,35],"tags":[95506],"coauthors":[61343],"class_list":["post-92902","post","type-post","status-publish","format-standard","hentry","category-featured","category-powershell","tag-automate"],"acf":[],"_links":{"self":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/92902","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/users\/319367"}],"replies":[{"embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/comments?post=92902"}],"version-history":[{"count":3,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/92902\/revisions"}],"predecessor-version":[{"id":92928,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/92902\/revisions\/92928"}],"wp:attachment":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/media?parent=92902"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/categories?post=92902"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/tags?post=92902"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/coauthors?post=92902"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}