{"id":245,"date":"2018-03-01T00:00:38","date_gmt":"2018-03-01T08:00:38","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/koryt\/?p=245"},"modified":"2020-04-29T10:09:00","modified_gmt":"2020-04-29T17:09:00","slug":"powershell-for-programmers-strings-quotes-and-quirks","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/powershell-for-programmers-strings-quotes-and-quirks\/","title":{"rendered":"PowerShell For Programmers: Strings, Quotes and Quirks"},"content":{"rendered":"

Welcome back everyone! This will be a short, but important entry for the guide. <\/span><\/p>\n

The difference between quote characters is something I\u2019m asked about all the time. It is important to understand in PowerShell, but most of the time it probably won\u2019t make a difference. <\/span><\/p>\n

TLDR:<\/strong> If you’re just typing a value like “alg” then it doesn’t matter, but if you have any special symbols you can see the difference. <\/span><\/p>\n

Single vs. Double Quotes<\/h2>\n

We refer to single quotes as Literal Strings and double quotes as Expandable Strings. Both create the same datatype (system.string), but a double quote will expand any special character and a single quote will use the literal characters you typed. <\/span><\/p>\n

\n
$a = \"test\"\r\n\r\n\"A is $a\"\r\n\r\n'A is $a'\r\n<\/span><\/pre>\n<\/div>\n
\n
 <\/p>\n
A is test\r\nA is $a<\/span><\/pre>\n
 <\/p>\n<\/div>\n
Variable Sub-Expressions<\/h2>\n
With an expandable string, you might run into some unintended behavior when you try to access a property of a variable (or do some other kinds of special actions). In these scenarios we need to use a variable sub expression or string concatenation (+ sign concatenates and so does -join). A sub expression uses $() to surround the special code we want to run inside our expandable string:<\/span><\/p>\n
\n
$service = get-service alg\r\n\"Service: $service\"<\/span><\/pre>\n<\/div>\n
\n
Service: System.ServiceProcess.ServiceController<\/span><\/pre>\n<\/div>\n
That doesn\u2019t look right!<\/span><\/p><\/blockquote>\n
When PowerShell isn\u2019t sure how to convert something to a string, it just shows you the data type you gave it. <\/span><\/p>\n
\u201cNo problem, I\u2019ll just access the property I want!\u201d ~Every programmer ever<\/span><\/p><\/blockquote>\n
 <\/p>\n
\n
\"Service: $service.Name\"<\/span><\/pre>\n<\/div>\n
\n
 <\/p>\n
Service: System.ServiceProcess.ServiceController.Name<\/span><\/pre>\n<\/div>\n
Not quite what we were expecting \"Sad<\/span><\/p>\n
\n
\"Service: $($Service.Name)\"<\/span><\/pre>\n<\/div>\n
\n
Service: alg<\/span><\/pre>\n
 <\/p>\n<\/div>\n
Eureka! \"Open-mouthed<\/span><\/p><\/blockquote>\n
This allows us to run code as well:<\/span><\/p>\n
\n
\"Date: $(get-date)\"<\/span><\/pre>\n
 <\/p>\n<\/div>\n
\n
Date: 01\/24\/2018 11:01:15<\/span><\/pre>\n
 <\/p>\n<\/div>\n
Now this solves the problem and allows us to write properties of our objects into strings. <\/span><\/p>\n
Simple String Manipulation<\/h2>\n
As I mentioned, concatenation also works. We can concatenate strings via the + sign, or \u2013join operator.<\/span><\/p>\n
\n
\"Service: \" + $Service.Name\r\n\"Service\",$Service.Name -join \": \" #you can join with any delimeter<\/span><\/pre>\n<\/div>\n
We also have operators and methods<\/u> for split and replace. The operators use Regex<\/a> and the methods do not. (I can do a post on regex in the future)<\/span><\/p>\n
\n
\"a,b,c,d,e\" -split \",\"\r\n\"a,b,c,d,e\".Split(\",\")\r\n\r\n\"a,b,c,d,e\" -replace \",\",\";\"\r\n\"a,b,c,d,e\".Replace(\",\",\";\")<\/span><\/pre>\n<\/div>\n
Feel free to pipe any string into Get-Member to see some of the other methods you might be familiar with and looking for. <\/span><\/p>\n
Format Operator<\/h2>\n
The format operator gets some pretty heavy use in C# and it lives here in PowerShell as well. If you\u2019re unfamiliar with it, the idea is that we want to put placeholders in our string and populate them with values from an array later. <\/span><\/p>\n
So, if we wanted to write out a bunch of comma-separated properties of an object we could do something like this:<\/span><\/p>\n
\n
# -f\r\n\"{0},{1},{2}\" -f $service.DisplayName,$service.StartType,$service.Status<\/span><\/pre>\n
 <\/p>\n<\/div>\n
Notice the place holders are a set of curly braces {} with an index number inside. They don\u2019t have to be in order, and they can be reused. <\/span><\/p>\n
We can also force specific format codes onto the data:<\/span><\/p>\n
\n
#c is the code for currency\r\n\"Cost: {0:c}\" -f 502342420.12<\/span><\/pre>\n
you can find the other codes here<\/a>, but its a bit annoying to get through.<\/span><\/p>\n<\/div>\n
I personally don\u2019t like to use the format operator very often, but it can do some pretty unique and impressive things when you need it. I found this<\/a> blog post to have a great reference about extra format operator information so I figured linking it would be better than reinventing the wheel. <\/span><\/p>\n
\u00a0<\/span><\/p>\n
Well that\u2019s all for now, hopefully this helps you on your PowerShell journey and helps you determine which quotes you need to use as well as get some useful manipulation done. I\u2019ll be addressing another kind of string, called a \u201cHere\u201d string in a short section later.<\/span><\/p>\n
I\u2019ll be adding to the series to cover other quirks as well so let me know in the comments if there is any particular topics confusing you!<\/span><\/p>\n
If you find this helpful don’t forget to rate, comment and share\u00a0\ud83d\ude42<\/span><\/p>\n
For the main series post, check back here.<\/a><\/span><\/p>\n","protected":false},"excerpt":{"rendered":"
Welcome back everyone! This will be a short, but important entry for the guide. The difference between quote characters is something I\u2019m asked about all the time. It is important to understand in PowerShell, but most of the time it probably won\u2019t make a difference. TLDR: If you’re just typing a value like “alg” then […]<\/p>\n","protected":false},"author":7300,"featured_media":87096,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1738,2126],"tags":[2221,2125],"class_list":["post-245","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","category-powershell_for_programmers","tag-kory-thacher","tag-koryt"],"acf":[],"blog_post_summary":"
Welcome back everyone! This will be a short, but important entry for the guide. The difference between quote characters is something I\u2019m asked about all the time. It is important to understand in PowerShell, but most of the time it probably won\u2019t make a difference. TLDR: If you’re just typing a value like “alg” then […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/245","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/7300"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=245"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/245\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=245"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=245"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=245"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}