FormatDateTime 関数 (Visual Basic)
更新 : 2007 年 11 月
日時の値を表す文字列式を返します。
Function FormatDateTime(
ByVal Expression As DateTime,
Optional ByVal NamedFormat As DateFormat = DateFormat.GeneralDate
) As String
パラメータ
Expression
必ず指定します。書式を変換する日付 (Date) を指定します。NamedFormat
省略可能です。使用されている日付または時刻形式を表す数値を指定します。この引数を省略すると、DateFormat.GeneralDate が指定されます。
設定
引数 NamedFormat の設定値は次のとおりです。
定数 |
説明 |
---|---|
DateFormat.GeneralDate |
日付か時刻、または両方を表示します。日付部を短い形式で表示します。時刻部がある場合は、時刻を長い形式で表示します。両方ある場合は、両方とも表示します。 |
DateFormat.LongDate |
[地域のオプション] で指定されている長い形式で日付を表示します。 |
DateFormat.ShortDate |
[地域のオプション] で指定されている短い形式で日付を表示します。 |
DateFormat.LongTime |
[地域のオプション] で指定されている形式で時刻を表示します。 |
DateFormat.ShortTime |
24 時間形式 (hh:mm) で時刻を表示します。 |
例外
例外の種類 |
エラー番号 |
条件 |
---|---|---|
NamedFormat の設定が有効ではありません。 |
非構造化エラー処理を使用する Visual Basic 6.0 アプリケーションをアップグレードする場合は、"エラー番号" の列を参照してください(エラー番号を Number プロパティ (Err オブジェクト) と比較することもできます)。ただし、可能であれば、このようなエラー制御は Visual Basic の構造化例外処理の概要 に置き換えることを検討してください。
解説
日付データ型 (Date) には、常に日付と時刻の両方の情報が含まれます。型変換のために、Visual Basic は 1/1/1 (西暦 1 年 1 月 1 日) を日付の基準値と見なし、00:00:00 (午前 0 時) を時刻の基準値と見なします。日付型 (Date) の値を日時の文字列として書式設定する場合、FormatDateTime は結果の文字列に基準値を含めません。たとえば、#1/1/0001 9:30:00# を文字列に変換すると、結果は "9:30:00 AM" となり、日付情報が省略されます。ただし、元の日付型 (Date) の値には日付情報が残っており、DatePart などの関数を使って復元できます。
メモ : |
---|
引数 Expression を String リテラルとして渡す場合、FormatDateTime はアプリケーションの CurrentCulture 設定に基づいて、この引数を解釈します。ただし、引数を Date リテラルとして渡す場合は、FormatDateTime が必ず English (US) カルチャに基づいて Date リテラルを解釈するため、#mm/dd/yyyy# の形式を使用してください。1 つのカルチャの Date リテラルを使用して開発およびコーディングされたアプリケーションを別のカルチャのプラットフォームで実行した場合には、Date リテラルが正しく解析されないことがあるため、この形式にする必要があります。 |
使用例
FormatDateTime 関数の使用例を次に示します。
' English (US) format.
Dim TestDate As DateTime = #3/12/1999#
' FormatDateTime returns "Friday, March 12, 1999".
' The time information is neutral (00:00:00) and therefore suppressed.
Dim TestString As String = FormatDateTime(TestDate, DateFormat.LongDate)
必要条件
名前空間 : Microsoft.VisualBasic
モジュール : Strings
アセンブリ : Visual Basic ランタイム ライブラリ (Microsoft.VisualBasic.dll)
参照
参照
FormatCurrency 関数 (Visual Basic)
FormatNumber 関数 (Visual Basic)