方法: 日付と時刻の値をラウンドトリップさせる

[アーティクル]
04/07/2023

ある特定の時点を明確に表すように日付と時刻の値を保つことは、多くのアプリケーションに共通する要件です。この記事では、DateTime 値、DateTimeOffset 値、日付と時刻の値とタイムゾーンの情報を保存し、復元する方法について示します。復元した値によって、保存した値と同じ時刻が識別されるようにします。

DateTime 値をラウンドトリップさせる

DateTime.ToString(String) メソッドを "o" 書式指定子と共に呼び出して、DateTime 値を対応する文字列形式に変換します。
DateTime 値の文字列形式をファイルに保存するか、プロセス、アプリケーションドメイン、またはマシン境界を通過させます。
DateTime 値を表す文字列を取得します。
DateTime.Parse(String, IFormatProvider, DateTimeStyles) メソッドを呼び出し、styles パラメーターの値として DateTimeStyles.RoundtripKind を渡します。

DateTime 値をラウンドトリップさせる方法を次の例に示します。

const string fileName = @".\DateFile.txt";

StreamWriter outFile = new StreamWriter(fileName);

// Save DateTime value.
DateTime dateToSave = DateTime.SpecifyKind(new DateTime(2008, 6, 12, 18, 45, 15),
                                           DateTimeKind.Local);
string? dateString = dateToSave.ToString("o");
Console.WriteLine("Converted {0} ({1}) to {2}.",
                  dateToSave.ToString(),
                  dateToSave.Kind.ToString(),
                  dateString);
outFile.WriteLine(dateString);
Console.WriteLine("Wrote {0} to {1}.", dateString, fileName);
outFile.Close();

// Restore DateTime value.
DateTime restoredDate;

using StreamReader inFile = new StreamReader(fileName);
dateString = inFile.ReadLine();

if (dateString is not null)
{
    restoredDate = DateTime.Parse(dateString, null, DateTimeStyles.RoundtripKind);
    Console.WriteLine("Read {0} ({2}) from {1}.", restoredDate.ToString(),
                                                  fileName,
                                                  restoredDate.Kind.ToString());
}

// The example displays the following output:
//    Converted 6/12/2008 6:45:15 PM (Local) to 2008-06-12T18:45:15.0000000-05:00.
//    Wrote 2008-06-12T18:45:15.0000000-05:00 to .\DateFile.txt.
//    Read 6/12/2008 6:45:15 PM (Local) from .\DateFile.txt.

Const fileName As String = ".\DateFile.txt"

Dim outFile As New StreamWriter(fileName)

' Save DateTime value.
Dim dateToSave As Date = DateTime.SpecifyKind(#06/12/2008 6:45:15 PM#, _
                                              DateTimeKind.Local)
Dim dateString As String = dateToSave.ToString("o")
Console.WriteLine("Converted {0} ({1}) to {2}.", dateToSave.ToString(), _
                  dateToSave.Kind.ToString(), dateString)
outFile.WriteLine(dateString)
Console.WriteLine("Wrote {0} to {1}.", dateString, fileName)
outFile.Close()

' Restore DateTime value.
Dim restoredDate As Date

Dim inFile As New StreamReader(fileName)
dateString = inFile.ReadLine()
inFile.Close()
restoredDate = DateTime.Parse(dateString, Nothing, DateTimeStyles.RoundTripKind)
Console.WriteLine("Read {0} ({2}) from {1}.", restoredDate.ToString(), _
                  fileName, restoredDAte.Kind.ToString())
' The example displays the following output:
'    Converted 6/12/2008 6:45:15 PM (Local) to 2008-06-12T18:45:15.0000000-05:00.
'    Wrote 2008-06-12T18:45:15.0000000-05:00 to .\DateFile.txt.
'    Read 6/12/2008 6:45:15 PM (Local) from .\DateFile.txt.

DateTime 値をラウンドトリップさせる場合、この方法により、あらゆる現地時刻と協定世界時刻を適切に保存できます。たとえば、現地時刻の DateTime 値が米国太平洋標準時タイムゾーンのシステムで保存され、米国中部標準時タイムゾーンのシステムで復元された場合、復元された日付と時刻は 2 つのタイムゾーンの時差を反映し、元の時刻より 2 時間後になります。ただし、タイムゾーンが指定されていない時刻の場合、この方法では必ずしも正確な結果を得られるわけではありません。 Kind プロパティが Unspecified であるすべての DateTime 値がローカル時間のように扱われます。ローカル時間でない場合は、DateTime によって正しい時点を識別することはできません。この制限を回避するには、日付と時刻の値と該当するタイムゾーンを確実に関連付けてから保存操作と復元操作を行います。

DateTimeOffset 値をラウンドトリップさせる

DateTimeOffset.ToString(String) メソッドを "o" 書式指定子と共に呼び出して、DateTimeOffset 値を対応する文字列形式に変換します。
DateTimeOffset 値の文字列形式をファイルに保存するか、プロセス、アプリケーションドメイン、またはマシン境界を通過させます。
DateTimeOffset 値を表す文字列を取得します。
DateTimeOffset.Parse(String, IFormatProvider, DateTimeStyles) メソッドを呼び出し、styles パラメーターの値として DateTimeStyles.RoundtripKind を渡します。

DateTimeOffset 値をラウンドトリップさせる方法を次の例に示します。

const string fileName = @".\DateOff.txt";

StreamWriter outFile = new StreamWriter(fileName);

// Save DateTime value.
DateTimeOffset dateToSave = new DateTimeOffset(2008, 6, 12, 18, 45, 15,
                                               new TimeSpan(7, 0, 0));
string? dateString = dateToSave.ToString("o");
Console.WriteLine("Converted {0} to {1}.", dateToSave.ToString(),
                  dateString);
outFile.WriteLine(dateString);
Console.WriteLine("Wrote {0} to {1}.", dateString, fileName);
outFile.Close();

// Restore DateTime value.
DateTimeOffset restoredDateOff;

using StreamReader inFile = new StreamReader(fileName);
dateString = inFile.ReadLine();

if (dateString is not null)
{
    restoredDateOff = DateTimeOffset.Parse(dateString, null,
                                           DateTimeStyles.RoundtripKind);
    Console.WriteLine("Read {0} from {1}.", restoredDateOff.ToString(), fileName);
}

// The example displays the following output:
//    Converted 6/12/2008 6:45:15 PM +07:00 to 2008-06-12T18:45:15.0000000+07:00.
//    Wrote 2008-06-12T18:45:15.0000000+07:00 to .\DateOff.txt.
//    Read 6/12/2008 6:45:15 PM +07:00 from .\DateOff.txt.

Const fileName As String = ".\DateOff.txt"

Dim outFile As New StreamWriter(fileName)

' Save DateTime value.
Dim dateToSave As New DateTimeOffset(2008, 6, 12, 18, 45, 15, _
                                     New TimeSpan(7, 0, 0))
Dim dateString As String = dateToSave.ToString("o")
Console.WriteLine("Converted {0} to {1}.", dateToSave.ToString(), dateString)
outFile.WriteLine(dateString)
Console.WriteLine("Wrote {0} to {1}.", dateString, fileName)
outFile.Close()

' Restore DateTime value.
Dim restoredDateOff As DateTimeOffset

Dim inFile As New StreamReader(fileName)
dateString = inFile.ReadLine()
inFile.Close()
restoredDateOff = DateTimeOffset.Parse(dateString, Nothing, DateTimeStyles.RoundTripKind)
Console.WriteLine("Read {0} from {1}.", restoredDateOff.ToString(), fileName)
' The example displays the following output:
'    Converted 6/12/2008 6:45:15 PM +07:00 to 2008-06-12T18:45:15.0000000+07:00.
'    Wrote 2008-06-12T18:45:15.0000000+07:00 to .\DateOff.txt.
'    Read 6/12/2008 6:45:15 PM +07:00 from .\DateOff.txt.

この方法により、DateTimeOffset 値は常にある特定の時点として明確に識別されます。識別されたら、DateTimeOffset.ToUniversalTime メソッドを呼び出すことで、この値を協定世界時 (UTC) に変換できます。あるいは、DateTimeOffset.ToOffset または TimeZoneInfo.ConvertTime(DateTimeOffset, TimeZoneInfo) メソッドを呼び出すことで、特定のタイムゾーンの時刻に変換できます。この方法には、特定のタイムゾーンの時刻を表す DateTimeOffset 値に対して日付と時刻の演算を行ったときに、そのタイムゾーンにおける正確な結果を得ることができない場合があるという重要な制限があります。これは、DateTimeOffset 値をインスタンス化すると、対応するタイムゾーンとの関連付けが解除されるためです。したがって、日付と時刻の計算を実行した場合、タイムゾーンの調整規則は適用されなくなります。この問題を回避するには、日付と時刻の値、および付随するタイムゾーンの両方を保持するカスタム型を定義します。

コードのコンパイル

これらの事例では、次の名前空間を C# using ステートメントまたは Visual Basic Imports ステートメントでインポートする必要があります:

次の方法で共有

方法: 日付と時刻の値をラウンドトリップさせる

DateTime 値をラウンドトリップさせる

DateTimeOffset 値をラウンドトリップさせる

コードのコンパイル

関連項目

その他のリソース