COleDateTimeSpan::Format

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

COleDateTimeSpan オブジェクトの書式化された文字列表現を生成します。

CString Format(
   LPCTSTR pFormat 
) const;
CString Format(
   UINT nID 
) const;

パラメータ

pFormat
printf の書式指定文字列と同じような書式指定文字列。パーセント (%) 記号に続く書式指定コードが、対応する COleDateTimeSpan の構成要素によって置き換えられます。書式指定文字列のその他の文字は、変更されることなく戻り値の文字列にコピーされます。Format の書式指定コードの値とその意味の一覧を以下に示します。
- %H 現在 CTimeSpan が保持している値を、日、時、分、秒に変換したときの "時"
- %M 現在 CTimeSpan が保持している値を、日、時、分、秒に変換したときの "分"
- %S 現在 CTimeSpan が保持している値を、日、時、分、秒に変換したときの "秒"
- %% パーセント記号
Format が受け取る書式指定コードはこれら 4 つだけです。
nID
書式指定文字列のリソース ID。

戻り値

書式化された期間値を含む CString を返します。

解説

これらの関数を呼び出して、期間値の書式化された表現を作成します。COleDateTimeSpan オブジェクトの状態が null のときは、戻り値は空文字列になります。状態が無効に設定されている場合、戻り値は文字列リソース IDS_INVALID_DATETIMESPAN で指定された文字列になります。

この関数の形式を簡単に説明します。

**Format(**pFormat )
この形式の関数は、printf と同様に、先頭にパーセント記号 (%) が付いた特殊な書式制御コードを持つ書式指定文字列を使用して、値を書式化します。書式指定文字列は、パラメータとして関数に渡されます。
**Format(**nID )
この形式の関数は、printf と同様に、先頭にパーセント記号 (%) が付いた特殊な書式制御コードを持つ書式指定文字列を使用して、値を書式化します。書式指定文字列はリソースです。この文字列のリソース ID は、パラメータとして関数に渡されます。

ロケール ID 値の一覧については、Windows SDK の「Supporting Multiple National Languages」を参照してください。

使用例

// get the current time
COleDateTime tmStart = COleDateTime::GetCurrentTime();

// waste some time
CString str;
::Sleep(3000);

// get the current time again
COleDateTime tmFinish = COleDateTime::GetCurrentTime();

// find the difference
COleDateTimeSpan tmSpan = tmFinish - tmStart;

// tell the user
str = tmSpan.Format(_T("%S seconds elapsed"));
_tprintf_s(_T("%s\n"), (LPCTSTR) str);