[GetTimeFormatWrapW は Windows XP で使用できます。 以降のバージョンでは使用できない場合があります。 その代わりに GetTimeFormatW を使用する必要があります。]
指定したロケールの時刻文字列として時刻を書式設定します。 関数は、指定された時刻またはローカル システム時刻の書式を設定します。
注意
GetTimeFormatWrapW は、 GetTimeFormatW 関数のラッパーです。 使用上の注意事項については、 GetTimeFormat ページを参照してください。
構文
int GetTimeFormatWrapW(
_In_ LCID Locale,
_In_ DWORD dwFlags,
_In_ const SYSTEMTIME *lpTime,
_In_ LPCWSTR pwzFormat,
_Out_ LPWSTR pwzTimeStr,
_In_ int cchTime
);
パラメーター
-
ロケール [in]
-
種類: LCID
時刻文字列を書式設定するロケールを指定します。 pwzFormat が NULL の場合、関数は、このロケールの時刻形式に従って文字列の書式を設定します。 pwzFormat が NULL でない場合、関数は、書式指定図文字列で指定されていない情報 (ロケールのタイム マーカーなど) に対してのみロケールを使用します。
このパラメーターには、 MAKELCID マクロによって作成されたロケール識別子、または次の定義済みの値のいずれかを指定できます。
-
LOCALE_SYSTEM_DEFAULT
-
既定のシステム ロケール。
-
LOCALE_USER_DEFAULT
-
既定のユーザー ロケール。
dwFlags [in]
型: DWORD
さまざまな関数オプションを指定します。 次の値の組み合わせを指定できます。
LOCALE_NOUSEROVERRIDE
設定されている場合、関数は、指定されたロケールのシステムの既定の時刻形式を使用して文字列の書式を設定します。 設定されていない場合、関数は、ロケールの既定の時刻形式に対するユーザー オーバーライドを使用して文字列の書式を設定します。 このフラグは、 pwzFormat が NULL の場合にのみ設定できます。
LOCALE_USE_CP_ACP
ロケール コード ページではなく、文字列変換にシステム ANSI コード ページを使用します。
TIME_NOMINUTESORSECONDS
分または秒を使用しません。
TIME_NOSECONDS
秒を使用しません。
TIME_NOTIMEMARKER
時間マーカーを使用しません。
TIME_FORCE24HOURFORMAT
常に 24 時間形式を使用します。
lpTime [in]
型: const SYSTEMTIME*
書式設定する時刻情報を含む SYSTEMTIME 構造体へのポインター。 このポインターが NULL の場合、関数は現在のローカル システム時刻を使用します。
pwzFormat [in]
種類: LPCWSTR
時刻文字列の形成に使用する形式へのポインター。 pwzFormat が NULL の場合、関数は指定されたロケールの時刻形式を使用します。 詳細については、「 GetTimeFormat 」を参照してください。
pwzTimeStr [out]
種類: LPWSTR
書式設定された時刻文字列を受け取るバッファーへのポインター。
cchTime [in]
型: int
pwzTimeStr バッファーのサイズ (文字単位)。 cchTime が 0 の場合、関数は書式設定された時刻文字列を保持するために必要な文字数を返し、pwzTimeStr によって指されるバッファーは使用されません。
戻り値
型: int
関数が成功した場合、戻り値は pwzTimeStr によって指されるバッファーに書き込まれた文字数です。 cchTime パラメーターが 0 の場合、戻り値は書式設定された時刻文字列を保持するために必要な文字数です。 カウントには、終端の null 文字が含まれます。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。 GetLastError は 、次のいずれかのエラー コードを返す場合があります。
-
ERROR_INSUFFICIENT_BUFFER
-
ERROR_INVALID_FLAGS
-
ERROR_INVALID_PARAMETER
注釈
GetTimeFormatWrapW は、Windows XP より前のオペレーティング システムで Unicode 文字列を使用する機能を提供します。 推奨される方法は、 GetTimeFormatW を Microsoft Layer for Unicode (MSLU) と組み合わせて使用することです。
GetTimeFormatWrapW は、序数 310 を使用して、Shlwapi.dllから直接呼び出す必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows 2000 Professional、Windows XP [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows Server 2003 [デスクトップ アプリのみ] |
| [DLL] |
|
こちらもご覧ください