Force Powershell functions to really return an array, even an empty array.
Due to the way the @() syntax is implemented, functions may not always return an array as expected, e.g. the following code will return a $null and NOT an empty array. If you are testing code with set-StrictMode -On set, you'll get an PropertyNotFoundStrict error instead when trying to reference the .count property:
function test
{
#some code that might return none,one or multiple values
$data = $null
return @($data)
}
(test).count
Simply prepending a , to the @() will bypass the "syntactic sugar" and you'll have an actual array returned, even if it's empty:
function test2
{
#some code that might return none,one or multiple values
$data = $null
return ,@($data)
}
(test2).count
Make your own custom functions and save them in your profile. You can build tons of useful functions without having to re-think it all every time a similar problem pops up.
Access any .net classes by using Add-Type -Assembly with the assembly name, or Add-Type -Path with the dll path, and then using syntax like [Namespace.Dotted.ClassName+NestedClass]::StaticMethod() to create a New-Object Namespace.Dotted.ClassName or invoke static methods/fields on types.
Save files using different encoding than UTF-16 in ISE.
The Powershell ISE defaults to saving all files as "Unicode Big Endian" (UTF-16) encoding. The following code will create a menu item in the ISE and assign a hotkey (default, Ctrl-Shift+E) to save the file in the current PowerShellISE tab using a specified encoding other than UTF-16. I set it to UTF-8, but you could use ASCII or something else if desired.
$iseProfile = $profile -replace '_profile','ISE_profile'
$addMenuCmdStr = '$psISE.CurrentPowerShellTab.AddOnsMenu.SubMenus.Add("_Save as UTF8",{$psIse.CurrentFile.Save([System.Text.Encoding]::UTF8)},"Ctrl+Shift+E")'
add-content $iseProfile -value $addMenuCmdStr
ise
This trick is useful for avoiding certain issues with PowerShell scripts such as:
Subversion (possibly other CVS systems) adds .ps1 files to the repository as binary and not as plain text, won't allow you to "diff" your scripts because they are "binary", or generates an error that a file cannot be added because it is "binary mime-type". Changing the encoding to UTF-8 should allow your files to be added to the repository with svn:mime-type/text-plain and allows the diff functions to work.
Signing code using set-AuthenticodeSignature fails for some files and not others
Probably other cases were file content operations work for some files and not others, often for no apparent reason, but one symptom is that only files created with the ISE have the issue.
Moving mine to an answer so I don't feel bad making this a commwiki.
Foreach loops:
PS C:\> foreach ($a in "a","b","c") { write $a }
a
b
c
Changedir to a UNC path:
PS C:\> cd \\kcws\c$
PS Microsoft.PowerShell.Core\FileSystem::\\kcws\c$>
Get running services:
PS C:> get-service | where {$_.status -eq "running"}
Status Name DisplayName
------ ---- -----------
Running AeLookupSvc Application Experience
Running Appinfo Application Information
Running AudioEndpointBu... Windows Audio Endpoint Builder
Running Audiosrv Windows Audio
[...]
This is more of a non-obvious hassle, but I once wrote a script to produce a CSV file as input for an older executable, ofiller.exe, which is used with Checkpoint firewalls.
I was using output redirection: Script.ps1 > outfile.csv
My powershell-created CSV file didn't work, where my hand-written test CSV file worked fine, even though the two files diff'ed identically. Only when I looked at the size of the files did I realize it was a Unicode Vs ASCII problem; the powershell CSV was twice as large.
Piping my output to | Out-File -format ASCII -name outfile.csv instead of the cheap & cheerful STDOUT redirection solved the problem.
Force Powershell functions to really return an array, even an empty array.
Due to the way the @() syntax is implemented, functions may not always return an array as expected, e.g. the following code will return a $null and NOT an empty array. If you are testing code with
set-StrictMode -On
set, you'll get anPropertyNotFoundStrict
error instead when trying to reference the.count
property:Simply prepending a
,
to the@()
will bypass the "syntactic sugar" and you'll have an actual array returned, even if it's empty:Make your own custom functions and save them in your profile. You can build tons of useful functions without having to re-think it all every time a similar problem pops up.
Edit your profile:
Access any .net classes by using
Add-Type -Assembly
with the assembly name, orAdd-Type -Path
with the dll path, and then using syntax like[Namespace.Dotted.ClassName+NestedClass]::StaticMethod()
to create aNew-Object Namespace.Dotted.ClassName
or invoke static methods/fields on types.Save files using different encoding than UTF-16 in ISE.
The Powershell ISE defaults to saving all files as "Unicode Big Endian" (UTF-16) encoding. The following code will create a menu item in the ISE and assign a hotkey (default, Ctrl-Shift+E) to save the file in the current PowerShellISE tab using a specified encoding other than UTF-16. I set it to UTF-8, but you could use ASCII or something else if desired.
This trick is useful for avoiding certain issues with PowerShell scripts such as:
Subversion (possibly other CVS systems) adds .ps1 files to the repository as binary and not as plain text, won't allow you to "diff" your scripts because they are "binary", or generates an error that a file cannot be added because it is "binary mime-type". Changing the encoding to UTF-8 should allow your files to be added to the repository with svn:mime-type/text-plain and allows the diff functions to work.
Signing code using set-AuthenticodeSignature fails for some files and not others
Probably other cases were file content operations work for some files and not others, often for no apparent reason, but one symptom is that only files created with the ISE have the issue.
Splatting. You can define a bunch of arguments in a Hashtable, and then use it as the parameters of a function.
Moving mine to an answer so I don't feel bad making this a commwiki.
Foreach loops:
Changedir to a UNC path:
Get running services:
PS C:> get-service | where {$_.status -eq "running"}
This is more of a non-obvious hassle, but I once wrote a script to produce a CSV file as input for an older executable, ofiller.exe, which is used with Checkpoint firewalls.
I was using output redirection:
Script.ps1 > outfile.csv
My powershell-created CSV file didn't work, where my hand-written test CSV file worked fine, even though the two files diff'ed identically. Only when I looked at the size of the files did I realize it was a Unicode Vs ASCII problem; the powershell CSV was twice as large.
Piping my output to
| Out-File -format ASCII -name outfile.csv
instead of the cheap & cheerful STDOUT redirection solved the problem.