GetDateFormatA 関数 (datetimeapi.h)

ロケール識別子で指定されたロケールの日付文字列として日付を書式設定します。 この関数は、指定した日付またはローカル システムの日付を書式設定します。

構文

int GetDateFormatA(
  [in]            LCID             Locale,
  [in]            DWORD            dwFlags,
  [in, optional]  const SYSTEMTIME *lpDate,
  [in, optional]  LPCSTR           lpFormat,
  [out, optional] LPSTR            lpDateStr,
  [in]            int              cchDate
);

パラメーター

[in] Locale

この関数が日付文字列の書式を設定するロケールを指定するロケール識別子。 MAKELCID マクロを使用してロケール識別子を作成するか、次のいずれかの定義済み値を使用できます。

• LOCALE_CUSTOM_DEFAULT
• LOCALE_CUSTOM_UI_DEFAULT
• LOCALE_CUSTOM_UNSPECIFIED
• LOCALE_INVARIANT
• LOCALE_SYSTEM_DEFAULT
• LOCALE_USER_DEFAULT

[in] dwFlags

日付形式オプションを指定するフラグ。 詳細な定義については、getDateFormatExの dwFlags パラメーター を参照してください。

[in, optional] lpDate

書式設定する日付情報を含む SYSTEMTIME 構造体へのポインター。 関数が現在のローカル システム日付を使用する場合、アプリケーションはこのパラメーターを NULL を するように設定します。

[in, optional] lpFormat

日付の形成に使用される書式指定図文字列へのポインター。 図の書式設定文字列に使用できる値は、日、月、年、および時代 (年) 形式の図で定義されます。

この関数では、書式指定の画像文字列で指定されていない情報 (ロケールの日と月の名前など) に対してのみ、指定されたロケールが使用されます。 アプリケーションでは、このパラメーターを NULL 設定して、指定したロケールの日付形式に従って文字列を書式設定できます。

[out, optional] lpDateStr

この関数が書式設定された日付文字列を取得するバッファーへのポインター。

[in] cchDate

lpDateStr バッファーのサイズ (文字数)。 アプリケーションでは、このパラメーターを 0 に設定して、書式設定された日付文字列を保持するために必要なバッファー サイズを返すことができます。 この場合、lpDateStr によって示されるバッファー 使用されません。

戻り値

成功した場合、lpDateStr バッファーに書き込まれた文字数を返します。 cchDate パラメーターが 0 に設定されている場合、この関数は、書式設定された日付文字列を保持するために必要な文字数 (終端の null 文字を含む) を返します。

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

• ERROR_INSUFFICIENT_BUFFER。 指定されたバッファー サイズが十分な大きさではなかったか、NULL正しく設定されていません。
• ERROR_INVALID_FLAGS。 フラグに指定された値が無効でした。
• ERROR_INVALID_PARAMETER。 パラメーター値のいずれかが無効でした。

備考