GetTimeFormatW

時刻を、識別子で指定したロケール用の時刻文字列としてフォーマットする。関数は指定された時刻またはローカルシステム時刻のいずれかをフォーマットする。(Unicode)

GetTimeFormatW Locale, dwFlags, lpTime, lpFormat, lpTimeStr, cchTime

Locale : [int] ロケールを指定するロケール識別子。MAKELCID マクロを使用してロケール識別子を作成するか、以下の定義済み値のいずれかを使用できる。
dwFlags : [int] 時刻形式オプションを指定するフラグ。詳細な定義については GetTimeFormatEx の dwFlags パラメータを参照。
lpTime : [var] フォーマットする時刻情報を含む SYSTEMTIME 構造体へのポインタ。関数が現在のローカルシステム時刻を使用する場合、アプリケーションはこのパラメータを NULL に設定できる。
lpFormat : [wstr] 時刻文字列のフォーマットに使用する書式絵へのポインタ。アプリケーションがこのパラメータを NULL に設定すると、関数は指定されたロケールの時刻形式に従って文字列をフォーマットする。アプリケーションがパラメータを NULL に設定しない場合、関数は書式絵文字列で指定されていない情報（たとえばロケール固有の時刻マーカ）にのみロケールを使用する。書式絵文字列の詳細は備考セクションを参照。
lpTimeStr : [wstr] この関数がフォーマット済み時刻文字列を取得するバッファへのポインタ。
cchTime : [int] lpTimeStr が示す時刻文字列バッファのサイズ（TCHAR 単位）。あるいは、アプリケーションはこのパラメータを 0 に設定できる。その場合、関数は時刻文字列バッファに必要なサイズを返し、lpTimeStr パラメータを使用しない。

(プラグイン / モジュール : kernel32.dll)

解説

時刻を、識別子で指定したロケール用の時刻文字列としてフォーマットする。関数は指定された時刻またはローカルシステム時刻のいずれかをフォーマットする。(Unicode)

[戻り値]
lpTimeStr が示すバッファに取得された TCHAR 値の数を返す。cchTime パラメータが 0
に設定されている場合、関数はフォーマット済み時刻文字列を保持するために必要なバッファのサイズ（終端 null
文字を含む）を返す。成功しなかった場合、関数は 0 を返す。拡張エラー情報を取得するには、アプリケーションは GetLastError
を呼ぶ。これは以下のいずれかのエラーコードを返す。
（以下省略）

[備考]
GetTimeFormatEx の備考を参照。Unicode 専用ロケール識別子と共にこの関数の ANSI
版を使用する場合、オペレーティングシステムがシステムコードページを使用するため関数は成功し得る。ただし、システムコードページで未定義の文字は文字列内で疑問符
(?) として現れる。
Windows 8 以降: GetTimeFormat は Datetimeapi.h で宣言されている。Windows 8 以前は
Winnls.h で宣言されていた。
> [!NOTE] > datetimeapi.h ヘッダは GetTimeFormat を、UNICODE
プリプロセッサ定数の定義に基づいて ANSI または Unicode
版を自動選択するエイリアスとして定義する。エンコーディング中立なエイリアスとそうでないコードを混在させると、コンパイルや実行時のエラーを引き起こす不一致が生じうる。詳細は
[Conventions for Function
Prototypes](/windows/win32/intl/conventions-for-function-prototypes)
を参照。

情報