GetTimeFormatW 関数 (datetimeapi.h)
識別子で指定されたロケールの時刻文字列として時刻を書式設定します。 関数は、指定された時刻またはローカル システム時刻の書式を設定します。
構文
int GetTimeFormatW(
[in] LCID Locale,
[in] DWORD dwFlags,
[in, optional] const SYSTEMTIME *lpTime,
[in, optional] LPCWSTR lpFormat,
[out, optional] LPWSTR lpTimeStr,
[in] int cchTime
);
パラメーター
[in] Locale
ロケール を指定するロケール識別子。 MAKELCID マクロを使用してロケール識別子を作成するか、次のいずれかの定義済み値を使用できます。
- LOCALE_CUSTOM_DEFAULT
- LOCALE_CUSTOM_UI_DEFAULT
- LOCALE_CUSTOM_UNSPECIFIED
- LOCALE_INVARIANT
- LOCALE_SYSTEM_DEFAULT
- LOCALE_USER_DEFAULT
[in] dwFlags
時刻形式オプションを指定するフラグ。 詳細な定義については、GetTimeFormatEx の dwFlags パラメーターを参照してください。
[in, optional] lpTime
書式設定する時刻情報を含む SYSTEMTIME 構造体へのポインター。 関数が現在のローカル システム時刻を使用する場合、アプリケーションはこのパラメーターを NULL に設定できます。
[in, optional] lpFormat
時刻文字列の書式設定に使用する書式図へのポインター。 アプリケーションでこのパラメーターを NULL に設定した場合、関数は指定されたロケールの時刻形式に従って文字列の書式を設定します。 アプリケーションで パラメーターが NULL に設定されていない場合、この関数は、ロケール固有のタイム マーカーなど、書式指定図文字列で指定されていない情報に対してのみロケールを使用します。 図の書式指定文字列の詳細については、「解説」セクションを参照してください。
[out, optional] lpTimeStr
この関数が書式設定された時刻文字列を取得するバッファーへのポインター。
[in] cchTime
lpTimeStr で示される時刻文字列バッファーのサイズ (TCHAR 値)。 または、アプリケーションでこのパラメーターを 0 に設定することもできます。 この場合、関数は時刻文字列バッファーに必要なサイズを返し、 lpTimeStr パラメーターは使用しません。
戻り値
lpTimeStr で示されるバッファーで取得された TCHAR 値の数を返します。 cchTime パラメーターが 0 に設定されている場合、関数は、書式設定された時刻文字列を保持するために必要なバッファーのサイズ (終端の null 文字を含む) を返します。
成功しなかった場合、この関数は 0 を返します。 拡張エラー情報を取得するために、アプリケーションは GetLastError を呼び出すことができます。これにより、次のいずれかのエラー コードが返されます。
- ERROR_INSUFFICIENT_BUFFER。 指定されたバッファー サイズが十分に大きくなかったか、 正しく NULL に設定されていませんでした。
- ERROR_INVALID_FLAGS。 フラグに指定された値が無効でした。
- ERROR_INVALID_PARAMETER。 パラメーター値のいずれかが無効です。
- ERROR_OUTOFMEMORY。 この操作を完了するのに十分なストレージが使用できませんでした。
注釈
「GetTimeFormatEx の備考」を参照してください。
この関数の ANSI バージョンを Unicode のみのロケール識別子と共に使用すると、オペレーティング システムでシステム コード ページが使用されるため、関数は成功する可能性があります。 ただし、システム コード ページで未定義の文字は、文字列に疑問符 (?) として表示されます。
Windows 8以降: GetTimeFormat は Datetimeapi.h で宣言されています。 Windows 8する前は、Winnls.h で宣言されていました。
注意
datetimeapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetTimeFormat を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | datetimeapi.h |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |