This documentation is archived and is not being maintained.

DateTime.ToLocalTime Method

Updated: January 2010

Converts the value of the current DateTime object to local time.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public Function ToLocalTime As DateTime
'Usage
Dim instance As DateTime 
Dim returnValue As DateTime 

returnValue = instance.ToLocalTime()

Return Value

Type: System.DateTime
A DateTime object whose Kind property is Local, and whose value is the local time equivalent to the value of the current DateTime object, or DateTime.MaxValue if the converted value is too large to be represented by a DateTime object, or DateTime.MinValue if the converted value is too small to be represented as a DateTime object.

The local time is equal to the Coordinated Universal Time (UTC) time plus the UTC offset. For more information about the UTC offset, see TimeZone.GetUtcOffset. The conversion also takes into account the daylight saving time rule that applies to the time represented by the current DateTime object.

Important noteImportant Note:

   The ToLocalTime method recognizes only the current adjustment rule when converting from UTC to local time. As a result, conversions for periods before the current adjustment rule came into effect may not accurately reflect the difference between UTC and local time.

Starting with the .NET Framework version 2.0, the value returned by the ToLocalTime method is determined by the Kind property of the current DateTime object. The following table describes the possible results.

Kind

Results

Utc

This instance of DateTime is converted to local time.

Local

No conversion is performed.

Unspecified

This instance of DateTime is assumed to be a UTC time, and the conversion is performed as if Kind were Utc.

NoteNote:

The ToLocalTime method converts a DateTime value from UTC to local time. To convert the time in any designated time zone to local time, use the TimeZoneInfo.ConvertTime method.

The value returned by the conversion is a DateTime whose Kind property always returns Local. Consequently, a valid result is returned even if ToLocalTime is applied repeatedly to the same DateTime.

Notes to Callers:

You can use the ToLocalTime method to restore a local date and time value that was converted to UTC by the ToUniversalTime or FromFileTimeUtc method. However, if the original time represents an invalid time in the local time zone, it will not match the restored value. When the ToLocalTime method converts a time from UTC to the local time zone, it also adjusts the time so that is valid in the local time zone.

For example, the transition from standard time to daylight time occurs in the U.S. Pacific Standard Time zone on March 14, 2010, at 2:00 A.M., when the time advances by one hour, to 3:00 A.M. This hour interval is an invalid time, that is, a time interval that does not exist in this time zone. The following example shows that when a time that falls within this range is converted to UTC by the ToUniversalTime method and is then restored by the ToLocalTime method, the original value is adjusted to become a valid time. You can determine whether a particular date and time value may be subject to modification by passing it to the TimeZoneInfo.IsInvalidTime method, as the example illustrates.

Module Example
   Public Sub Main()
      Dim date1 As New Date(2010, 3, 14, 2, 30, 0, DateTimeKind.Local)
      Console.WriteLine("Invalid time: {0}", _
                        TimeZoneInfo.Local.IsInvalidTime(date1))
      Dim utcDate1 As Date = date1.ToUniversalTime()
      Dim date2 As Date = utcDate1.ToLocalTime()
      Console.WriteLine("{0} --> {1}", date1, date2)      
   End Sub 
End Module 
' The example displays the following output: 
'       Invalid time: True 
'       3/14/2010 2:30:00 AM --> 3/14/2010 3:30:00 AM

The following example demonstrates the ToLocalTime method.

System.Console.WriteLine("Enter a date and time.")
Dim strDateTime As String
strDateTime = System.Console.ReadLine()

Dim localDateTime As System.DateTime
Try
   localDateTime = System.DateTime.Parse(strDateTime)
Catch exp As System.FormatException
   System.Console.WriteLine("Invalid format.")
End Try 

Dim univDateTime As System.DateTime
univDateTime = localDateTime.ToUniversalTime()

System.Console.WriteLine("{0} local time is {1} universal time.", _
                           localDateTime, _
                           univDateTime)

System.Console.WriteLine("Enter a date and time in universal time.")
strDateTime = System.Console.ReadLine()

Try
   univDateTime = System.DateTime.Parse(strDateTime)
Catch exp As System.FormatException
   System.Console.WriteLine("Invalid format.")
End Try

localDateTime = univDateTime.ToLocalTime()

System.Console.WriteLine("{0} universal time is {1} local time.", _
                           univDateTime, _
                           localDateTime)

The following example uses the SpecifyKind method to demonstrate how the Kind property influences the ToLocalTime and ToUniversalTime conversion methods.


' This code example demonstrates the DateTime Kind, Now, and 
' UtcNow properties, and the SpecifyKind(), ToLocalTime(),  
' and ToUniversalTime() methods. 
Imports System

Class Sample
    Public Shared Sub Main() 
        ' Get the date and time for the current moment, adjusted  
        ' to the local time zone. 
        Dim saveNow As DateTime = DateTime.Now

        ' Get the date and time for the current moment expressed  
        ' as coordinated universal time (UTC). 
        Dim saveUtcNow As DateTime = DateTime.UtcNow
        Dim myDt As DateTime

        ' Display the value and Kind property of the current moment  
        ' expressed as UTC and local time.
        DisplayNow("UtcNow: ..........", saveUtcNow)
        DisplayNow("Now: .............", saveNow)
        Console.WriteLine()

        ' Change the Kind property of the current moment to  
        ' DateTimeKind.Utc and display the result.
        myDt = DateTime.SpecifyKind(saveNow, DateTimeKind.Utc)
        Display("Utc: .............", myDt)

        ' Change the Kind property of the current moment to  
        ' DateTimeKind.Local and display the result.
        myDt = DateTime.SpecifyKind(saveNow, DateTimeKind.Local)
        Display("Local: ...........", myDt)

        ' Change the Kind property of the current moment to  
        ' DateTimeKind.Unspecified and display the result.
        myDt = DateTime.SpecifyKind(saveNow, DateTimeKind.Unspecified)
        Display("Unspecified: .....", myDt)
    End Sub 'Main

    ' Display the value and Kind property of a DateTime structure, the  
    ' DateTime structure converted to local time, and the DateTime  
    ' structure converted to universal time.  

    Public Shared datePatt As String = "M/d/yyyy hh:mm:ss tt" 

    Public Shared Sub Display(ByVal title As String, ByVal inputDt As DateTime) 
        Dim dispDt As DateTime = inputDt
        Dim dtString As String 

        ' Display the original DateTime.
        dtString = dispDt.ToString(datePatt)
        Console.WriteLine("{0} {1}, Kind = {2}", title, dtString, dispDt.Kind)

        ' Convert inputDt to local time and display the result.  
        ' If inputDt.Kind is DateTimeKind.Utc, the conversion is performed. 
        ' If inputDt.Kind is DateTimeKind.Local, the conversion is not performed. 
        ' If inputDt.Kind is DateTimeKind.Unspecified, the conversion is  
        ' performed as if inputDt was universal time.
        dispDt = inputDt.ToLocalTime()
        dtString = dispDt.ToString(datePatt)
        Console.WriteLine("  ToLocalTime:     {0}, Kind = {1}", dtString, dispDt.Kind)

        ' Convert inputDt to universal time and display the result.  
        ' If inputDt.Kind is DateTimeKind.Utc, the conversion is not performed. 
        ' If inputDt.Kind is DateTimeKind.Local, the conversion is performed. 
        ' If inputDt.Kind is DateTimeKind.Unspecified, the conversion is  
        ' performed as if inputDt was local time.
        dispDt = inputDt.ToUniversalTime()
        dtString = dispDt.ToString(datePatt)
        Console.WriteLine("  ToUniversalTime: {0}, Kind = {1}", dtString, dispDt.Kind)
        Console.WriteLine()
    End Sub 'Display


    ' Display the value and Kind property for DateTime.Now and DateTime.UtcNow. 

    Public Shared Sub DisplayNow(ByVal title As String, ByVal inputDt As DateTime) 
        Dim dtString As String = inputDt.ToString(datePatt)
        Console.WriteLine("{0} {1}, Kind = {2}", title, dtString, inputDt.Kind)
    End Sub 'DisplayNow
End Class 'Sample


'This code example produces the following results: 

'UtcNow: .......... 5/6/2005 09:34:42 PM, Kind = Utc 
'Now: ............. 5/6/2005 02:34:42 PM, Kind = Local 

'Utc: ............. 5/6/2005 02:34:42 PM, Kind = Utc 
'  ToLocalTime:     5/6/2005 07:34:42 AM, Kind = Local 
'  ToUniversalTime: 5/6/2005 02:34:42 PM, Kind = Utc 

'Local: ........... 5/6/2005 02:34:42 PM, Kind = Local 
'  ToLocalTime:     5/6/2005 02:34:42 PM, Kind = Local 
'  ToUniversalTime: 5/6/2005 09:34:42 PM, Kind = Utc 

'Unspecified: ..... 5/6/2005 02:34:42 PM, Kind = Unspecified 
'  ToLocalTime:     5/6/2005 07:34:42 AM, Kind = Local 
'  ToUniversalTime: 5/6/2005 09:34:42 PM, Kind = Utc 
'

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

January 2010

Added the Notes for Callers section.

Content bug fix.

Show: