Functions/ConvertFrom-DateTime.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
function ConvertFrom-DateTime { <# .SYNOPSIS Converts a datetime into a datetime represented in a different format. .DESCRIPTION Converts a datetime into a datetime represented in a different format. All datetime output is in local timezone. If you wish the output to be in UTC timezone include the -UTC parameter. .PARAMETER DateTime The date that you want to be converted. Can be input from the pipeline. .PARAMETER DMTF A switch parameter to display in DMTF format. Default parameter set. DmtfDateTime is of the form 'yyyymmddHHMMSS.ffffff+UUU' Where yyyy is the 4 digit year mm is the 2 digit month dd is the 2 digit day of the month HH is the 2 digit in 24 hour format (00-23, 1 pm = 13) MM is the 2 digit minute (00-59) SS is the 2 digit second (00-59) ffffff is the 6 digit microsecond + is a plus or minus to indicate offset from UTC UUU is the 3 digit number of minutes offset from UTC (000-720) .PARAMETER Unix Switch to convert a datetime to a UnixEpoch which is the number of seconds since '1/1/1970 12:00:00 AM UTC' .PARAMETER FileTime Switch to convert a datetime to a large integer filetime [int64]. There is a special value that returns a value of 'Never'. Returns a [datetime] in Universal Time (UTC) Filetimes are expressed in Ticks. Ticks can range from 0 - 2650467743999999999. Translating these into dates you get 0 = Monday, January 01, 1601 12:00:00.00000 AM 2650467743999999999 = Friday, December 31, 9999 11:59:59.99999 PM .PARAMETER ICSDateTime Switch to convert a datetime to IcsDateTime format is of the form 'yyyymmddTHHMMSSZ' Where yyyy is the 4 digit year mm is the 2 digit month dd is the 2 digit day of the month HH is the 2 digit in 24 hour format (00-23, 1 pm = 13) MM is the 2 digit minute (00-59) SS is the 2 digit second (00-59) T is the letter T Z is an optional suffix indicating UTC or Zulu time If the final character is NOT a Z then the time is local time. .PARAMETER ISO8601 Switch to convert a datetime to ISO-8601 format: 'yyyy.MM.ddTHH:mm:ss' .PARAMETER Excel Switch to indicate that the datestring is in Excel format which represents dates as the number of days since (get-date 1/1/1900) .PARAMETER Format See help for Get-Date and the -Format parameter. This duplicates that capability. .PARAMETER IncludeInput Switch to enable the original datetime to appear in the output. Aliased to 'IncludeOriginal' .PARAMETER UTC Forces the output to be in the UTC timezone. Alias of this parameter is 'Zulu' .EXAMPLE ConvertFrom-DateTime -DateTime '1/28/1986 11:39' -FileTime -IncludeInput DateTime FileTime -------- -------- 1/28/1986 11:39:00 AM 121517879400000000 .EXAMPLE ConvertFrom-DateTime -DateTime '1/25/2018 8:34:31 AM' -DMTF -IncludeInput Assuming a timezone of 'Eastern Time' and a culture of 'en-US' this would return the string 20180125083431.000000-300 .EXAMPLE ConvertFrom-DateTime -DateTime '1/25/2018 8:34:31 AM' -DMTF -IncludeInput Assuming your current timezone is EST then the output would be: DateTime DMTF -------- ---- 1/25/2018 8:34:31 AM 20180125083431.000000-300 .EXAMPLE ConvertFrom-DateTime -DateTime '1/25/2018 8:34:31 AM' -DMTF -UTC Assuming your current timezone is EST then the output would be: 20180125133431.000000+000 .EXAMPLE '3/15/2018 12:00:00 PM' | ConvertFrom-DateTime -UTC Assuming a timezone of 'Eastern Time' and a culture of 'en-US' this would return the string 20180315160000.000000+000 .NOTES Info: For further information on DMTF time formats see https://docs.microsoft.com/en-us/windows/desktop/wmisdk/cim-datetime Added Excel functionality #> #region parameter [CmdletBinding(DefaultParameterSetName = 'DMTF')] [OutputType('string')] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter','')] Param ( [Parameter(ValueFromPipeline, Position = 0, ParameterSetName = 'DMTF')] [Parameter(ValueFromPipeline, Position = 0, ParameterSetName = 'Unix')] [Parameter(ValueFromPipeline, Position = 0, ParameterSetName = 'FileTime')] [Parameter(ValueFromPipeline, Position = 0, ParameterSetName = 'ICSDateTime')] [Parameter(ValueFromPipeline, Position = 0, ParameterSetName = 'ISO8601')] [Parameter(ValueFromPipeline, Position = 0, ParameterSetName = 'Format')] [Parameter(ValueFromPipeline, Position = 0, ParameterSetName = 'Excel')] [Alias('DateTime')] [datetime[]] $Date = (Get-Date), [Parameter(ParameterSetName = 'DMTF')] [switch] $DMTF, [Parameter(ParameterSetName = 'Unix')] [switch] $Unix, [Parameter(ParameterSetName = 'FileTime')] [switch] $FileTime, [Parameter(ParameterSetName = 'ICSDateTime')] [switch] $ICSDateTime, [Parameter(ParameterSetName = 'ISO8601')] [switch] $ISO8601, [Parameter(ParameterSetName = 'Excel')] [switch] $Excel, [Parameter(ParameterSetName = 'Format')] [string] $Format, [Parameter(ParameterSetName = 'DMTF')] [Parameter(ParameterSetName = 'Unix')] [Parameter(ParameterSetName = 'FileTime')] [Parameter(ParameterSetName = 'ICSDateTime')] [Parameter(ParameterSetName = 'ISO8601')] [Parameter(ParameterSetName = 'Format')] [Parameter(ParameterSetName = 'Excel')] [Alias('IncludeOriginal')] [switch] $IncludeInput, [Parameter(ParameterSetName = 'DMTF')] [Parameter(ParameterSetName = 'Unix')] [Parameter(ParameterSetName = 'FileTime')] [Parameter(ParameterSetName = 'ICSDateTime')] [Parameter(ParameterSetName = 'ISO8601')] [Parameter(ParameterSetName = 'Format')] [Parameter(ParameterSetName = 'Excel')] [Alias('Zulu')] [switch] $UTC ) #endregion parameter begin { Write-Verbose -Message "Starting [$($MyInvocation.Mycommand)]" Write-Verbose -Message "ParameterSetName [$($PsCmdlet.ParameterSetName)]" $BeginUnixEpoch = Get-Date -Date '1/1/1970' $strCurrentTimeZone = (Get-CimInstance -ClassName win32_timezone -Verbose:$false).Description Write-Verbose -Message "Your local timezone is '$strCurrentTimeZone'" } process { foreach ($D in $Date) { if ($UTC) { $D = ConvertTo-UTC -Date $D } Write-Verbose -message "You entered a datetime of: '$D'" switch ($PsCmdlet.ParameterSetName) { 'DMTF' { $ReturnVal = [Management.ManagementDateTimeConverter]::ToDmtfDateTime(($D)) } 'Unix' { $ReturnVal = ([timespan] ($D - $BeginUnixEpoch)).TotalSeconds } 'FileTime' { $ReturnVal = $D.ToFileTime() } 'ICSDateTime' { if ($UTC) { $ReturnVal = Get-Date -Date $D -Format 'yyyyMMddTHHmmssZ' } else { $ReturnVal = Get-Date -Date $D -Format 'yyyyMMddTHHmmss' } } 'ISO8601' { if ($UTC) { $ReturnVal = Get-Date -Date $D -Format 'yyyy.MM.ddTHH:mm:ssZ' } else { $ReturnVal = Get-Date -Date $D -Format 'yyyy.MM.ddTHH:mm:ss' } } 'Excel' { if ($UTC) { $ReturnVal = ([double] ( (ConvertTo-UTC -Date (Get-Date -Date $D)) - (Get-Date -Date 1/1/1900) ).TotalDays) } else { $ReturnVal = ([double] ((Get-Date -Date $D) - (Get-Date -Date 1/1/1900)).TotalDays) } } 'Format' { $ReturnVal = Get-Date -Date $D -Format $Format } } if ($IncludeInput) { $prop = ([ordered] @{ DateTime = $D } ) switch ($PsCmdlet.ParameterSetName) { 'DMTF' { $prop.DMTF = $ReturnVal } 'Unix' { $prop.Unix = $ReturnVal } 'FileTime' { $prop.FileTime = $ReturnVal } 'ICSDateTime' { $prop.ICSDateTime = $ReturnVal } 'ISO8601' { $prop.ISO8601 = $ReturnVal } 'Format' { $prop.Format = $ReturnVal } 'Excel' { $prop.Excel = $ReturnVal } } New-Object -TypeName psobject -Property $prop } else { Write-Output -inputobject $ReturnVal } } } end { Write-Verbose -Message "Ending [$($MyInvocation.Mycommand)]" } } #EndFunction ConvertFrom-DateTime |