This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
I wrote the code below as a means of Time Zone lookup and conversion. One of the things I wanted was completion of names based on ID, System Name, Display Name, or Daylight Name. But while the code works, the argument lookup doesn't. What's wrong?
PowerShell
$mapCommonTimeZones =
@{
'UTC' = [TimeZoneInfo]::UTC;
'PST' = ([TimeZoneInfo]::FindSystemTimeZoneById('Pacific Standard Time') | Where-Object { $_.DisplayName -match '\(US \& Canada\)' })[0];
'MST' = ([TimeZoneInfo]::FindSystemTimeZoneById('Mountain Standard Time'))[0];
'CST' = ([TimeZoneInfo]::FindSystemTimeZoneById('Central Standard Time') | Where-Object { $_.DisplayName -match '\(US \& Canada\)' })[0];
'EST' = ([TimeZoneInfo]::FindSystemTimeZoneById('Mountain Standard Time'))[0];
};
class TimeZoneCompleter : System.Management.Automation.IArgumentCompleter
{
[System.Collections.Generic.IEnumerable[System.Management.Automation.CompletionResult]] CompleteArgument([string] $strCmdName, [string] $strParamName, [string] $strWordToComplete, [System.Management.Automation.Language.CommandAst] $cmdAst, [System.Collections.IDictionary]$mapFakeBoundParameters)
{
return (([TimeZoneInfo]::GetSystemTimeZones() + $global:mapCommonTimeZones.Values) | Where-Object { $_.Id -like "$strWordToComplete*" -or $_.DisplayName -like "$strWordToComplete*" -or $_.DaylightName -like "$strWordToComplete*" -or $_.StandardName -like "$strWordToComplete*" } | ForEach-Object { Write-Output (new System.Management.Automation.CompletionResult $_.Id) });
}
}
function Get-AllTimeZones
{
[OutputType([TimeZoneInfo[]])]
param
(
[Parameter(Position = 1, ValueFromRemainingArguments, ValueFromPipeline)]
[ValidateNotNullOrEmpty()]
[ArgumentCompleter([TimeZoneCompleter])]
[string[]]
$astrPartialTimeZoneInfo
)
Write-Output ($PSBoundParameters.ContainsKey('astrPartialTimeZoneInfo') ? ($astrPartialTimeZoneInfo | ForEach-Object { $curInfo = $_; $mapCommonTimeZones.Contains($_) ? $mapCommonTimeZones[$_] : ([System.TimeZoneInfo]::GetSystemTimeZones() | Where-Object { $_.Id -like "$curInfo*" }).Id }) : [System.TimeZoneInfo]::GetSystemTimeZones());
}
function Convert-TimeZones
{
[OutputType([datetime])]
param
(
[Parameter(Mandatory, Position = 0)]
[DateTime]
$dateFrom,
[Parameter(Mandatory, Position = 1, ParameterSetName = 'TZ_TZ')]
[Parameter(Mandatory, Position = 1, ParameterSetName = 'TZ_STR')]
[ValidateNotNull()]
[System.TimeZoneInfo]
$timezoneFrom,
[Parameter(Mandatory, Position = 2, ParameterSetName = 'TZ_TZ')]
[Parameter(Mandatory, Position = 2, ParameterSetName = 'STR_TZ')]
[ValidateScript({ $_ -ne $null -and $_ -ne $timezoneFrom })]
[System.TimeZoneInfo]
$timezoneTo,
[Parameter(Mandatory, Position = 1, ParameterSetName = 'STR_STR')]
[Parameter(Mandatory, Position = 1, ParameterSetName = 'STR_TZ')]
[ValidateScript({ $_ -ne $null -and $_ -ne '' -and (Get-AllTimeZones $_).length -ge 0 })]
[ArgumentCompleter([TimeZoneCompleter])]
[string]
$strFromTimeZone,
[Parameter(Mandatory, Position = 2, ParameterSetName = 'STR_STR')]
[Parameter(Mandatory, Position = 2, ParameterSetName = 'TZ_STR')]
[ValidateScript({ $_ -ne $null -and $_ -ne '' -and (Get-AllTimeZones $_).length -ge 0 })]
[ArgumentCompleter([TimeZoneCompleter])]
[string]
$strToTimeZone
)
begin
{
$timezoneFrom = $PSBoundParameters['timezoneFrom'] ? $timezoneFrom : (Get-TimeZone $strFromTimeZone);
$timezoneTo = $PSBoundParameters['timezoneTo'] ? $timezoneTo : (Get-TimeZone $strToTimeZone);
}
process
{
Write-Output ([TimeZoneInfo]::ConvertTime($dateFrom, $timezoneFrom, $timezoneTo));
}
}
Since you're using PowerShell, why not stick to writing the argument completer in PowerShell, too?
Does this help? about_functions_argument_completion
My code is written in PowerShell. And I did rely on the help topic you linked.
Oops. That code relies on an alias being declared above. Sorry for the shortened code. set-alias new new-object
There was only one "new" on line 15. I just changed that to new-object but it still won't parse.
Interesting. I thought it was snowballing.
Can you verify that this is a valid replacement for the code on your line #15 in the Get-AllTimeZone function?
if ($PSBoundParameters.ContainsKey('astrPartialTimeZoneInfo')){
$astrPartialTimeZoneInfo |
ForEach-Object {
$curInfo = $_
if ($mapCommonTimeZones.Contains($_)){
$mapCommonTimeZones[$_]
}
else{
[System.TimeZoneInfo]::GetSystemTimeZones() |
Where-Object { $_.Id -like "$curInfo*" } |
Select-Object -Expand Id
}
}
}
else{
[System.TimeZoneInfo]::GetSystemTimeZones()
}
I've used ternary operators in Perl, but I've always written them (except very short ones) by indenting them in the same way I'd write If/Else conditionals.
I removed the "Write-Output" because it's unnecessary.
Looks like it, but here's a slightly modified version of my code. I rearranged it somewhat. Note: There are sections of my code (but possibly not here) that rely on some declarations.
The required declarations:
. AssertTrue.ps1;
Set-Alias Assert Assert-True;
Set-Alias new New-Object
$mapCommonTimeZones =
@{
'UTC' = [TimeZoneInfo]::UTC;
'PST' = ([TimeZoneInfo]::FindSystemTimeZoneById('Pacific Standard Time') | Where-Object { $_.DisplayName -match '\(US \& Canada\)' })[0];
'MST' = ([TimeZoneInfo]::FindSystemTimeZoneById('Mountain Standard Time'))[0];
'CST' = ([TimeZoneInfo]::FindSystemTimeZoneById('Central Standard Time') | Where-Object { $_.DisplayName -match '\(US \& Canada\)' })[0];
'EST' = ([TimeZoneInfo]::FindSystemTimeZoneById('Mountain Standard Time'))[0];
};
AssertTrue.ps1 is PowerShell Gallery | Functions/Assert-True.ps1 0.15.0.
The new version of my code will be in the next comment due to length. (One declaration was shown above due to length..)
I don't think the code in the completer is being called.
Part 2 of above
class TimeZoneCompleter : System.Management.Automation.IArgumentCompleter
{
[System.Collections.Generic.IEnumerable[System.Management.Automation.CompletionResult]] CompleteArgument([string] $strCmdName, [string] $strParamName, [string] $strWordToComplete, [System.Management.Automation.Language.CommandAst] $cmdAst, [System.Collections.IDictionary]$mapFakeBoundParameters)
{
return (([TimeZoneInfo]::GetSystemTimeZones() + $global:mapCommonTimeZones.Values) | Where-Object { $_.Id -like "$strWordToComplete*" -or $_.DisplayName -like "$strWordToComplete*" -or $_.DaylightName -like "$strWordToComplete*" -or $_.StandardName -like "$strWordToComplete*" } | ForEach-Object { Write-Output (new System.Management.Automation.CompletionResult $_.Id) });
}
}
Part 3 of that code:
function Get-AllTimeZones
{
[OutputType([TimeZoneInfo[]])]
param
(
[Parameter(Position = 1, ValueFromRemainingArguments, ValueFromPipeline)]
[ValidateNotNullOrEmpty()]
[ArgumentCompleter([TimeZoneCompleter])]
[string[]]
$astrPartialTimeZoneInfo
)
if ($PSBoundParameters.ContainsKey('astrPartialTimeZoneInfo'))
{
foreach ($curInfo in $astrPartialTimeZoneInfo)
{
if ($mapCommonTimeZones.Contains($curInfo))
{
Write-Output $mapCommonTimeZones[$curInfo];
}
else
{
Write-Output ([System.TimeZoneInfo]::GetSystemTimeZones() | Where-Object { $_.Id -like "$curInfo*" -or $_.DisplayName -like "$curInfo*" -or $_.DaylightName -like "$curInfo*" -or $_.StandardName -like "$curInfo*" }).Id;
}
else
{
[System.TimeZoneInfo]::GetSystemTimeZones();
}
}
}
}
I did just notice Visual Studio code thinks the ArgumentCompleter attribute lines are types. Could that be a problem? Doesn't seem to affect things at runtime.
Just FYI: The value assigned to the "EST" key in the $mapCommonTimeZones hash looks to me to be wrong. Shouldn't it be 'Easter Standard Time" and not 'Mountain Standard Time'? You already have 'Mountain Standard Time' assigned to the 'MST' key.
Fixed it. I had to build a collection and then return it.
class TimeZoneCompleter : System.Management.Automation.IArgumentCompleter
{
[System.Collections.Generic.IEnumerable[System.Management.Automation.CompletionResult]] CompleteArgument([string] $strCmdName, [string] $strParamName, [string] $strWordToComplete, [System.Management.Automation.Language.CommandAst] $cmdAst, [System.Collections.IDictionary]$mapFakeBoundParameters)
{
[System.Management.Automation.CompletionResult[]]$result = [System.Management.Automation.CompletionResult[]]@();
([TimeZoneInfo]::GetSystemTimeZones() + $global:mapCommonTimeZones.Values) | Where-Object { $_.Id -like "$strWordToComplete*" -or $_.DisplayName -like "$strWordToComplete*" -or $_.DaylightName -like "$strWordToComplete*" -or $_.StandardName -like "$strWordToComplete*" } | ForEach-Object { $result += (new System.Management.Automation.CompletionResult "'$($_.Id)'", ($_.Id), ([Management.Automation.CompletionResultType]::ParameterValue), ($_.DisplayName)) };
return $result;
}
}
Your script isn't parsing correctly for me. PS 5.1 on Win10.
@MotoX80 : He's using PowerShell 7. All those ternary operators (i.e., "?" and ":") make PS5 barf.
Thx Rich. You can handle this one. I don't have 7 installed anywhere.
Sign in to comment