EnumTimeFormatsW 関数 (winnls.h)
識別子で指定されたロケールで使用できる時刻形式を列挙します。
構文
BOOL EnumTimeFormatsW(
[in] TIMEFMT_ENUMPROCW lpTimeFmtEnumProc,
[in] LCID Locale,
[in] DWORD dwFlags
);
パラメーター
[in] lpTimeFmtEnumProc
アプリケーション定義のコールバック関数へのポインター。 詳細については、「 EnumTimeFormatsProc」を参照してください。
[in] Locale
時刻形式情報を取得するロケールを指定するロケール識別子。 MAKELCID マクロを使用してロケール識別子を作成するか、次のいずれかの定義済み値を使用できます。
- LOCALE_CUSTOM_DEFAULT
- LOCALE_CUSTOM_UI_DEFAULT
- LOCALE_CUSTOM_UNSPECIFIED
- LOCALE_INVARIANT
- LOCALE_SYSTEM_DEFAULT
- LOCALE_USER_DEFAULT
[in] dwFlags
時刻の形式。 このパラメーターは、次のいずれかの値の組み合わせを指定できます。
戻り値
成功した場合は 0 以外の値を返し、それ以外の場合は 0 を返します。 拡張エラー情報を取得するために、アプリケーションは GetLastError を呼び出すことができます。このエラー コードは、次のいずれかのエラー コードを返すことができます。
- ERROR_INVALID_FLAGS。 フラグに指定された値が無効です。
- ERROR_INVALID_PARAMETER。 パラメーター値のいずれかが無効です。
注釈
関数は、時間形式を含むバッファーへのポインターをアプリケーション定義のコールバック関数に渡すことによって、時刻形式を列挙します。 列挙体の最初の値は、常にユーザーの既定値 (オーバーライド) 値です。 関数は、最後の時刻形式が見つかるか、コールバック関数が FALSE を返すまで列挙を続行します。
この関数は、 カスタム ロケールのデータを列挙できます。 データは、コンピューター間、またはアプリケーションの実行間で同じであるとは限りません。 アプリケーションでデータを永続化または送信する必要がある場合は、「 永続的なロケール データの使用」を参照してください。
この関数の ANSI バージョンを Unicode のみのロケール識別子と共に使用すると、システムがシステム コード ページを使用するため、呼び出しは成功します。 ただし、システム コード ページで未定義の文字は、文字列に疑問符 ("?") として表示されます。 今後導入された dwFlags の新しい値は、ANSI バージョンでは機能しないことに注意してください。
注意
winnls.h ヘッダーは EnumTimeFormats をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winnls.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |