For most people, when you create a script in PowerShell you generally don't worry too much about how it is encoded. Most everything you encounter in PowerShell uses Unicode files. But when sharing files sometimes this causes problems. For example, when I post a script for download here, I need to make sure it is encoded using ASCII, otherwise formatting can get a little borked. I've also run into issues with editing the same file among different editors. Often what I need is a way to set the encoding. The manual way would be to use Notepad and select an appropriate encoding when using Save As. But that doesn't scale. What I need is a way to take a group of files and set encoding. Here's my PowerShell solution.
\nWhen I first tackled this problem I thought I was going to have to deal with arcane .NET classes. Then I remembered that Out-File has a parameter to specify encoding. All I had to do was take the content of the original file and send it to the same file with the appropriate encoding.
\nTechnically, Out-File is creating a new file but I wanted to keep the same name. The easiest solution was to get the contents of the current file and same them to a variable. Then use that as the input for Out-File.
\n[cc lang=\"PowerShell\"]
\n $content=Get-Content -Path $file
\n $filedata=Get-Item -Path $file
\n Write-Verbose \"$(Get-Date) Saving content\"
\n Out-File -FilePath $file -Encoding $Encoding -InputObject $content
\n[\/cc]
\nOne drawback, at least for me, is that results in a new file which means it has a new time stamp. Most of the time I want to leave this data alone so my Set-FileEncoding function has a parameter called -SaveTime that will take the time stamp values from the original file and copy them to the \"new\" file.
\n[cc lang=\"PowerShell\"]
\nif ($SaveTime)
\n {
\n #get the \"new\" file
\n $f=Get-Item -Path $file
\n Write-Verbose \"$(Get-Date) Retaining original time stamp values\"
\n if ($pscmdlet.ShouldProcess(\"Resetting Timestamp on $file\"))
\n {
\n #revert timestamp values
\n $f.CreationTime=$filedata.CreationTime
\n $f.CreationTimeUtc=$filedata.CreationTimeUtc
\n $f.LastAccessTime= $filedata.LastAccessTime
\n $f.LastAccessTimeUtc=$filedata.LastAccessTimeUtc
\n $f.LastWriteTime=$filedata.LastWriteTime
\n $f.LastWriteTimeUtc=$filedata.LastWriteTimeUtc
\n }
\n }
\n[\/cc]
\nThe end result is that I have a \"new\" copy of my file but with new encoding. Here's my function with the comment based help omitted.
\n[cc lang=\"PowerShell\"]
\nFunction Set-FileEncoding {
\n[cmdletBinding(SupportsShouldProcess=$True)]<\/p>\n
Param (
\n [Parameter(Position=0,Mandatory=$True,HelpMessage=\"Enter a file name and <\/p>\n
path.\",
\n ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True)]
\n [ValidateNotNullorEmpty()]
\n [Alias(\"PSPath\",\"Name\")]
\n [string[]]$Path,<\/p>\n
[ValidateSet(\"Unicode\", \"UTF7\", \"UTF8\", \"UTF32\", <\/p>\n
\"ASCII\",\"BigEndianUnicode\", \"Default\",\"OEM\")]
\n [string]$Encoding=\"ASCII\",<\/p>\n
[switch]$SaveTime,<\/p>\n
[switch]$Passthru
\n)<\/p>\n
Begin
\n{
\n Write-Verbose \"$(Get-Date) Starting $($myinvocation.command)\"
\n}<\/p>\n
Process
\n{
\n foreach ($file in $path)
\n {
\n Write-Verbose \"$(Get-Date) Setting encoding on $File to $Encoding\"
\n Write-Verbose \"$(Get-Date) Getting content\"
\n $content=Get-Content -Path $file
\n $filedata=Get-Item -Path $file
\n Write-Verbose \"$(Get-Date) Saving content\"
\n Out-File -FilePath $file -Encoding $Encoding -InputObject $content<\/p>\n
if ($SaveTime)
\n {
\n #get the \"new\" file
\n $f=Get-Item -Path $file
\n Write-Verbose \"$(Get-Date) Retaining original time stamp values\"
\n if ($pscmdlet.ShouldProcess(\"Resetting Timestamp on $file\"))
\n {
\n #revert timestamp values
\n $f.CreationTime=$filedata.CreationTime
\n $f.CreationTimeUtc=$filedata.CreationTimeUtc
\n $f.LastAccessTime= $filedata.LastAccessTime
\n $f.LastAccessTimeUtc=$filedata.LastAccessTimeUtc
\n $f.LastWriteTime=$filedata.LastWriteTime
\n $f.LastWriteTimeUtc=$filedata.LastWriteTimeUtc
\n }
\n }
\n if ($PassThru)
\n {
\n Get-Item -Path $file
\n }<\/p>\n
} #foreach
\n} #process<\/p>\n
End
\n{
\n Write-Verbose \"$(Get-Date) Ending $($myinvocation.command)\"
\n}<\/p>\n
} #end function
\n[\/cc]
\nThe default encoding is set to ASCII but you can specify any encoding supported by Out-File. The function does not write anything to the pipeline. But you can use -Passthru and then the function will write the file object to the pipeline. Here are some examples:
\n[cc lang=\"PowerShell\"]
\nPS C:\\> Set-FileEncoding c:\\files\\data.txt -encoding Unicode
\nPS C:\\> dir c:\\scripts\\*.ps1 | set-fileencoding -savetime
\n[\/cc]
\nI hope it goes with out saying but don't try to use this with anything other than text files. Otherwise you will end up with corrupt files. If you can open the file and read it in Notepad then it should be fine.<\/p>\n