EnumDateFormatsExA 関数 (winnls.h)

指定したロケールで使用できる長い日付、短い日付、または年/月の形式を列挙します。

メモ Windows Vista 以降でのみ実行されるアプリケーションでは、この関数よりも EnumDateFormatsExEx を使用する必要があります。
 

構文

BOOL EnumDateFormatsExA(
  [in] DATEFMT_ENUMPROCEXA lpDateFmtEnumProcEx,
  [in] LCID                Locale,
  [in] DWORD               dwFlags
);

パラメーター

[in] lpDateFmtEnumProcEx

アプリケーション定義のコールバック関数へのポインター。 詳細については、「 EnumDateFormatsProcEx」を参照してください。

[in] Locale

日付形式情報を取得するロケールを指定するロケール識別子MAKELCID マクロを使用して識別子を作成するか、次のいずれかの定義済み値を使用できます。

Windows Vista 以降: 次のカスタム ロケール識別子もサポートされています。

[in] dwFlags

日付形式を指定するフラグ。 詳細な定義については、EnumDateFormatsExExdwFlags パラメーターを参照してください。

戻り値

成功した場合は 0 以外の値を返し、それ以外の場合は 0 を返します。 拡張エラー情報を取得するために、アプリケーションは GetLastError を呼び出すことができます。これにより、次のいずれかのエラー コードが返されます。

  • ERROR_INVALID_FLAGS。 フラグに指定された値が無効でした。
  • ERROR_INVALID_PARAMETER。 パラメーター値のいずれかが無効です。

注釈

メモ この API は、2019 年 5 月の日本の時代変更をサポートするように更新されています。 アプリケーションで日本語カレンダーがサポートされている場合は、新しい時代 (年号) が適切に処理されていることを検証する必要があります。 詳細については、「 日本の時代 (年号) の変更に合わせてアプリケーションを準備 する」を参照してください。
 
関数は、指定されたアプリケーション定義のコールバック関数に日付書式文字列ポインターを一度に 1 つずつ渡すことによって、日付形式を列挙します。 このプロセスは、 EnumDateFormatsEx が 最後の日付形式を見つけるか、コールバック関数が FALSE を返すまで続行されます。

この関数は、代替カレンダー (存在する場合) を含む、指定されたロケールのすべての日付形式を列挙します。 ただし、カレンダー識別子は日付形式と共に列挙されないため、代替カレンダーを含むロケールの形式を使用するのが困難になります。

この関数は、 カスタム ロケールのデータを列挙できます。 データは、コンピューター間、またはアプリケーションの実行間で同じになることは保証されません。 アプリケーションでデータを永続化または送信する必要がある場合は、「 永続的なロケール データの使用」を参照してください。

この関数の ANSI バージョンを Unicode のみのロケール識別子と共に使用すると、オペレーティング システムでシステム コード ページが使用されるため、関数は成功する可能性があります。 ただし、システム コード ページで未定義の文字は、文字列に疑問符 (?) として表示されます。

アプリケーションでは、 EnumDateFormatsEx ( EnumDateFormats ではなく) を使用して、代替カレンダーを含むロケールの日付形式を列挙する必要があります。

注意

winnls.h ヘッダーは EnumDateFormatsEx をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winnls.h (Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

EnumDateFormats

EnumDateFormatsExEx

EnumDateFormatsProcEx

各国語サポート

各国語サポート関数