Strings.FormatDateTime メソッド

.NET Framework クラス ライブラリ リファレンス

Strings.FormatDateTime メソッド

日付/時刻の値を表す文字列式を返します。

名前空間: Microsoft.VisualBasic
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

Public Shared Function FormatDateTime
 ( _
    Expression As DateTime, _
    <OptionalAttribute> Optional NamedFormat As
 DateFormat = DateFormat.GeneralDate _
) As String

Visual Basic (使用法)

Dim Expression As DateTime
Dim NamedFormat As DateFormat
Dim returnValue As String

returnValue = Strings.FormatDateTime(Expression, NamedFormat)

C#

public static string FormatDateTime
 (
    DateTime Expression,
    [OptionalAttribute] DateFormat NamedFormat
)

C++

public:
static String^ FormatDateTime (
    DateTime Expression, 
    [OptionalAttribute] DateFormat NamedFormat
)

J#

public static String FormatDateTime (
    DateTime Expression, 
    /** @attribute OptionalAttribute() */ DateFormat NamedFormat
)

JScript

public static function FormatDateTime
 (
    Expression : DateTime, 
    NamedFormat : DateFormat
) : String

パラメータ

Expression

必須。書式設定する Date 型の式。

NamedFormat

省略可能。使用する日付/時刻形式を示す数値。省略した場合は、DateFormat.GeneralDate が使用されます。

戻り値
日付/時刻の値を表す文字列式を返します。

解説

詳細については、Visual Basic のトピック「FormatDateTime 関数 (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 設定に応じて解釈します。ただし、FormatDateTime は常に Date リテラルを英語 (米国) カルチャに応じて解釈するので、Date リテラルとして渡した場合は形式 #mm/dd/yyyy# を使用します。1 つのカルチャの Date リテラルを使って開発およびコード化されたアプリケーションを別のカルチャで実行した場合に、Date リテラルが正しく解析されない場合があるので、この形式にする必要があります。

NamedFormat 引数には、次の設定があります。

定数	説明
DateFormat.GeneralDate	日付か時刻、または両方を表示します。日付部分を短い形式で表示します。時刻部分がある場合は、時刻を長い形式で表示します。日付部分と時刻部分が存在する場合は、両方とも表示します。
DateFormat.LongDate	コンピュータの地域設定に指定されている長い日付形式を使用して日付を表示します。
DateFormat.ShortDate	コンピュータの地域設定に指定されている短い日付形式を使用して日付を表示します。
DateFormat.LongTime	コンピュータの地域設定に指定されている時刻形式を使用して時刻を表示します。
DateFormat.ShortTime	24 時間形式 (hh:mm) を使用して表示します。

使用例

FormatDateTime 関数の使用例を次に示します。

Visual Basic

' 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)

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Strings クラス
Strings メンバ
Microsoft.VisualBasic 名前空間
ArgumentException
その他の技術情報
FormatDateTime 関数 (Visual Basic)
FormatCurrency 関数 (Visual Basic)
FormatNumber 関数 (Visual Basic)
FormatPercent 関数 (Visual Basic)
DatePart 関数 (Visual Basic)
文字列操作の概要