COleDateTime::Format
書式化された表現の日付/時刻値を作成します。
CString Format(
DWORD dwFlags = 0,
LCID lcid = LANG_USER_DEFAULT
) const;
CString Format(
LPCTSTR lpszFormat
) const;
CString Format(
UINT nFormatID
) const;
パラメーター
dwFlags
次のロケール フラグの 1 つを返します。LOCALE_NOUSEROVERRIDE カスタム ユーザー設定ではなく、システムの既定のロケール設定を使います。
VAR_TIMEVALUEONLY 解析のときに、日付部分を無視します。
VAR_DATEVALUEONLY 解析のときに、時刻部分を無視します。
lcid
変換に使用するロケール ID。 言語識別子の詳細については、「Language Identifiers」を参照してください。lpszFormat
printf の書式指定文字列と同じような書式指定文字列。 パーセント (%) 記号に続く各書式指定コードが、対応する COleDateTime の構成要素によって置き換えられます。 書式指定文字列のその他の文字は、変更されることなく戻り値の文字列にコピーされます。 詳細については、ランタイム関数 strftime の説明を参照してください。 Format の書式指定コードの値とその意味は以下のとおりです。%H 現在 COleDateTime が保持している値を、日、時、分、秒に変換したときの "時"
%M 現在 COleDateTime が保持している値を、日、時、分、秒に変換したときの "分"
%S 現在 COleDateTime が保持している値を、日、時、分、秒に変換したときの "秒"
%% パーセント記号
nFormatID
書式指定文字列のリソース ID。
戻り値
書式化された日付/時刻値を持つ CString を返します。
解説
COleDateTime オブジェクトの状態が null のときは、戻り値は空文字列になります。 状態が無効なときは、文字列リソース ATL_IDS_DATETIME_INVALID で指定される文字列が返されます。
この関数の 3 つの形式を次に簡単に説明します。
Format( dwFlags, lcid)
この形式では、日付/時刻の国別言語指定 (ロケール ID) を使って値が書式化されます。 この形式で既定のパラメーターを使用した場合、時刻部分が 0 (午前 0 時) でない限り、日付と時刻の両方が出力されます。時刻部分が 0 のときは、日付だけが印刷されます。日付部分が 0 (1899 年 12 月 30 日) のときは、時刻だけが出力されます。 日付/時刻の値が 0 (1899/12/30) のときは、既定のパラメーターでは午前 0 時が出力されます。Format( lpszFormat)
この形式の関数は、printf と同様に、先頭にパーセント記号 (%) が付いた特殊な書式制御コードを持つ書式指定文字列を使用して、値を書式化します。 書式指定文字列は、パラメーターとして関数に渡されます。 書式制御コードの詳細については、「ランタイム ライブラリ リファレンス」の「strftime、wcsftime」を参照してください。Format( nFormatID)
この形式の関数は、printf と同様に、先頭にパーセント記号 (%) が付いた特殊な書式制御コードを持つ書式指定文字列を使用して、値を書式化します。 書式指定文字列はリソースです。 この文字列のリソース ID は、パラメーターとして関数に渡されます。 書式制御コードの詳細については、「ランタイム ライブラリ リファレンス」の「strftime、wcsftime」を参照してください。
使用例
COleDateTime t(1999, 3, 19, 22, 15, 0);
CString str = t.Format(_T("%A, %B %d, %Y"));
ASSERT(str == _T("Friday, March 19, 1999"));
必要条件
**ヘッダー:**atlcomtime.h