Export (0) Print
Expand All
Expand Minimize

DateTime.ToLocalTime Method

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

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

public:
DateTime ToLocalTime ()
public DateTime ToLocalTime ()
public function ToLocalTime () : DateTime
Not applicable.

Return Value

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 MaxValue if the converted value is too large to be represented by a DateTime object, or 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.

NoteImportant:

   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 System.TimeZoneInfo.ConvertTime(System.DateTime,System.TimeZoneInfo,System.TimeZoneInfo) 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.

The following code example demonstrates the ToLocalTime method.

System::Console::WriteLine( "Enter a date and time." );
String^ strDateTime = System::Console::ReadLine();

System::DateTime localDateTime;
try
{
   localDateTime = System::DateTime::Parse( strDateTime );
}
catch ( System::FormatException^ ) 
{
   System::Console::WriteLine( "Invalid format." );
   return;
}

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 ( System::FormatException^ ) 
{
   System::Console::WriteLine( "Invalid format." );
   return;
}

localDateTime = univDateTime.ToLocalTime();

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

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

System.DateTime localDateTime;
try {
    localDateTime = System.DateTime.Parse(strDateTime);
}
catch (System.FormatException exp) {
    System.Console.WriteLine("Invalid format.");
    return;
}
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 (System.FormatException exp) {
    System.Console.WriteLine("Invalid format.");
    return;
}
localDateTime = univDateTime.ToLocalTime();
System.Console.WriteLine("{0} universal time is {1} local time.", 
    univDateTime, localDateTime);

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

No code example is currently available or this language may not be supported.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2015 Microsoft