{"id":8019,"date":"2014-10-21T06:00:00","date_gmt":"2014-10-21T13:00:00","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/?p=8019"},"modified":"2014-10-17T09:42:37","modified_gmt":"2014-10-17T16:42:37","slug":"a-better-tostring-method-for-hash-tables","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2014\/10\/21\/a-better-tostring-method-for-hash-tables\/","title":{"rendered":"A Better ToString() Method for Hash Tables"},"content":{"rendered":"

I didn\u2019t make it to the PowerShell Summit 2014 in Europe this year, but I\u2019ve been getting much of the benefit by watching the Summit presentations on YouTube<\/a>. After watching Windows PowerShell MVP Bartek Bielawski\u2019s excellent presentation<\/a>, in which he reviews PSCustomObjects and dynamic type data, I was inspired to fix a shortcoming in the .NET framework that often frustrates me.<\/p>\n

It\u2019s easy to create a hash table in Windows PowerShell:<\/p>\n

\n
@{Name <\/span>=<\/span> \"Fred\"<\/span>; ID <\/span>=<\/span> \"3\"<\/span>}<\/span><\/pre>\n<\/blockquote>\n
 <\/p>\n
And, beginning in Windows PowerShell 3.0, it\u2019s easy to get a hash table string from a file and convert it to a hash table object. Use the Invoke-Expression cmdlet and the Raw parameter of the Get-Content cmdlet. (Some nice folks on Twitter have reported that this technique does not work on files with digital signatures.)<\/p>\n
\n
$result<\/span> =<\/span> Invoke-Expression<\/span> (<\/span>Get-Content<\/span> \u2013Raw \u2013Path <filename>)<\/span><\/pre>\n<\/blockquote>\n
 <\/p>\n
For example, the module manifest files in Windows PowerShell contain a hash table string. If you open them in Notepad, they look like this:<\/p>\n
\"image\"<\/a><\/p><\/blockquote>\n
If you get the content of that hash table…<\/p>\n
\n
Get-Content<\/span> (<\/span>Get-Module<\/span> \u2013List BranchCache).Path<\/span><\/pre>\n<\/blockquote>\n
… you get a string.<\/p>\n
But if you use Invoke-Expression and the Raw parameter of Get-Content, you get a hash table. And, you can get the values of keys in the manifest hash table, such as FormatsToProcess, either by using a dot to get the property or by using conventional hash table syntax.<\/p>\n
\n
PS<\/span> C:\\> <\/span>$manifest<\/span> =<\/span> `\r\n    Invoke-Expression<\/span> (<\/span>Get-Content<\/span> \u2013Raw <\/span>-Path<\/span> (<\/span>Get-Module<\/span> \u2013List BranchCache).Path)\r\n<\/span>PS<\/span> C:\\> <\/span>$manifest<\/span>.FormatsToProcess\r\n<\/span>BranchCache.format.ps1xml<\/span><\/pre>\n
PS<\/span> C:\\> <\/span>$manifest<\/span>[<\/span>'FormatsToProcess'<\/span>]\r\n<\/span>BranchCache.format.ps1xml<\/span><\/pre>\n<\/blockquote>\n
 <\/p>\n
So, the only piece that was missing was saving a hash table as a string in a file. The obvious solution is the ToString() method of hash tables, but that just returns the type.<\/p>\n
\n
PS<\/span> C:\\> <\/span>$manifest<\/span> =<\/span> `\r\n    Invoke-Expression<\/span> (<\/span>Get-Content<\/span> \u2013Raw <\/span>-Path<\/span> (<\/span>Get-Module<\/span> \u2013List BranchCache).Path)\r\n<\/span>PS<\/span> C:\\> <\/span>$manifest<\/span>.toString()\r\n<\/span>System.Collections.Hashtable<\/span><\/pre>\n<\/blockquote>\n
 <\/p>\n
I wrote a little function that converts any hash table to a string. There\u2019s no magic here. It just builds a string that conforms to the hash table syntax for Windows PowerShell. The only tricky part was using escape characters to preserve quotation marks when the key includes a special character. (Hint: I used PowerRegEx in the SAPIEN Productivity Pack<\/a> to find that \u201c\\s\u201d.)<\/p>\n
    function<\/span> Convert-HashToString<\/span>\r\n    {\r\n        <\/span>param<\/span>\r\n        (\r\n            [<\/span>Parameter<\/span>(Mandatory <\/span>=<\/span> $true<\/span>)]\r\n            [<\/span>System.Collections.Hashtable<\/span>]\r\n            <\/span>$Hash<\/span>\r\n        )\r\n        <\/span>$hashstr<\/span> =<\/span> \"@{\"<\/span>\r\n        $keys<\/span> =<\/span> $Hash<\/span>.keys\r\n        <\/span>foreach<\/span> (<\/span>$key<\/span> in<\/span> $keys<\/span>)\r\n        {\r\n            <\/span>$v<\/span> =<\/span> $Hash<\/span>[<\/span>$key<\/span>]\r\n            <\/span>if<\/span> (<\/span>$key<\/span> -match<\/span> \"\\s\"<\/span>)\r\n            {\r\n                <\/span>$hashstr<\/span> +=<\/span> \"`\"$key`\"\"<\/span> +<\/span> \"=\"<\/span> +<\/span> \"`\"$v`\"\"<\/span> +<\/span> \";\"<\/span>\r\n            }\r\n            <\/span>else<\/span>\r\n            {\r\n                <\/span>$hashstr<\/span> +=<\/span> $key<\/span> +<\/span> \"=\"<\/span> +<\/span> \"`\"$v`\"\"<\/span> +<\/span> \";\"<\/span>\r\n            }\r\n        }\r\n        <\/span>$hashstr<\/span> +=<\/span> \"}\"<\/span>\r\n        return<\/span> $hashstr<\/span>\r\n    }<\/span><\/pre>\n
 <\/p>\n
But, I don\u2019t want to run a function or script. I want this code to run when I call the ToString() method of a hash table. So, I used the Update-TypeData trick that Bartek explains so nicely. (You can also read about it in the help topic for Update-TypeData<\/a>, but Bartek is more fun to watch.)<\/p>\n
This was easier than I thought. I used the Update-TypeData cmdlet. I set the value of the TypeName parameter\u00a0to the full name of the hash table type, System.Collections.HashTable. It\u2019s a script for a method, so I used the ScriptMethod member type. And, I want to override the current (not very helpful) ToString() method, so I set the MemberName parameter value\u00a0to ToString.<\/p>\n
The Value is the content of my little function. The only change I made was to replace the $hash<\/strong> parameter value with $this<\/strong>, which indicates the instances of the HashTable class.<\/p>\n
    Update-TypeData<\/span> -TypeName<\/span> System.Collections.HashTable `\r\n    <\/span>-MemberType<\/span> ScriptMethod `\r\n    <\/span>-MemberName<\/span> ToString `\r\n    <\/span>-Value<\/span> { <\/span>$hashstr<\/span> =<\/span> \"@{\"<\/span>; <\/span>$keys<\/span> =<\/span> $this<\/span>.keys; <\/span>foreach<\/span> (<\/span>$key<\/span> in<\/span> $keys<\/span>) { <\/span>$v<\/span> =<\/span> $this<\/span>[<\/span>$key<\/span>]; \r\n             <\/span>if<\/span> (<\/span>$key<\/span> -match<\/span> \"\\s\"<\/span>) { <\/span>$hashstr<\/span> +=<\/span> \"`\"$key`\"\"<\/span> +<\/span> \"=\"<\/span> +<\/span> \"`\"$v`\"\"<\/span> +<\/span> \";\"<\/span> }\r\n             <\/span>else<\/span> { <\/span>$hashstr<\/span> +=<\/span> $key<\/span> +<\/span> \"=\"<\/span> +<\/span> \"`\"$v`\"\"<\/span> +<\/span> \";\"<\/span> } }; <\/span>$hashstr<\/span> +=<\/span> \"}\"<\/span>;\r\n             <\/span>return<\/span> $hashstr<\/span> }<\/span><\/pre>\n
 <\/p>\n
Voila! When I ran it, I could use the new method to generate a hash table string.<\/p>\n
    PS<\/span> C:\\> <\/span>$h<\/span> = @{ Name <\/span>=<\/span> \"JuneB\"<\/span>; Language <\/span>=<\/span> \"PowerShell\"<\/span> }\r\n\r\n    <\/span>PS<\/span> C:\\> <\/span>$h<\/span>.Language\r\n    <\/span>PowerShell<\/span>\r\n\r\n    PS<\/span> C:\\> <\/span>$h<\/span>.ToString()\r\n    @{ Name <\/span>=<\/span> \"JuneB\"<\/span>; Language <\/span>=<\/span> \"PowerShell\"<\/span>; }<\/span><\/pre>\n
 <\/p>\n
Now, it\u2019s easy to save the hash table string in a file.<\/p>\n
    PS<\/span> C:\\> <\/span>$h<\/span>.ToString() > .\\hash.txt\r\n\r\n    <\/span>PS<\/span> C:\\> <\/span>Get-Content<\/span> .\\hash.txt\r\n    @{ Name <\/span>=<\/span> \"JuneB\"<\/span>; Language <\/span>=<\/span> \"PowerShell\"<\/span>; }<\/span><\/pre>\n
 <\/p>\n
And, convert it back to a hash table.<\/p>\n
\n
PS<\/span> C:\\> <\/span>$hashback<\/span> =<\/span> Invoke-Expression<\/span> (<\/span>Get-Content<\/span> -Raw<\/span> .\\hash.txt)\r\n\r\n<\/span>PS<\/span> C:\\> <\/span>$hashback<\/span>.language \r\n<\/span>PowerShell\r\n<\/span><\/pre>\n
PS<\/span> C:\\> <\/span>$hashback<\/span>.gettype().fullname\r\n<\/span>System.Collections.Hashtable<\/span><\/pre>\n<\/blockquote>\n
 <\/p>\n
The only glitch is that dynamic type data is specific to a session, so I saved the Update-TypeData command in my Windows PowerShell profile. Now, it\u2019s available to me in every Windows PowerShell session that uses my profile.<\/p>\n
The moral of the story is that it takes an hour to watch a PowerShell Summit presentation, but the inspiration might save you days of work.<\/p>\n
June Blender is a technology evangelist at SAPIEN Technologies, Inc. You can reach her at juneb@sapien.com<\/a>\u00a0and follow her on Twitter at @juneb_get_help<\/a>.<\/i><\/p>\n","protected":false},"excerpt":{"rendered":"
I didn\u2019t make it to the PowerShell Summit 2014 in Europe this year, but I\u2019ve been getting much of the benefit by watching the Summit presentations on YouTube. After watching Windows PowerShell MVP Bartek Bielawski\u2019s excellent presentation, in which he reviews PSCustomObjects and dynamic type data, I was inspired to fix a shortcoming in the […]<\/p>\n","protected":false},"author":31,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[25],"tags":[934,28],"class_list":["post-8019","post","type-post","status-publish","format-standard","hentry","category-windows-powershell","tag-juneb","tag-powershell"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/8019","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/users\/31"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=8019"}],"version-history":[{"count":16,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/8019\/revisions"}],"predecessor-version":[{"id":8035,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/8019\/revisions\/8035"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=8019"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=8019"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=8019"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}