[GetDateFormatWrapW は Windows XP で使用できます。 以降のバージョンでは使用できません。 その代わりに GetDateFormatW を使用する必要があります。]
指定したロケールの日付文字列として日付を書式設定します。 関数は、指定された日付またはローカル システムの日付を書式設定します。
注意
GetDateFormatWrapW は、 GetDateFormatW 関数のラッパーです。 使用上の注意事項については、 GetDateFormat ページを参照してください。
構文
int GetDateFormatWrapW(
_In_ LCID Locale,
_In_ DWORD dwFlags,
_In_ const SYSTEMTIME *lpDate,
_In_ LPCWSTR pwzFormat,
_Out_ LPWSTR pwzDateStr,
_In_ int cchDate
);
パラメーター
-
ロケール [in]
-
種類: LCID
日付文字列を書式設定するロケール。 pwzFormat が NULL の場合、関数は、このロケールの日付形式に従って文字列の書式を設定します。 pwzFormat が NULL でない場合、関数は、書式指定の画像文字列で指定されていない情報 (ロケールの日や月の名前など) に対してのみロケールを使用します。
このパラメーターには、 MAKELCID マクロによって作成されたロケール識別子、または次の定義済みの値のいずれかを指定できます。
-
LOCALE_SYSTEM_DEFAULT
-
既定のシステム ロケール。
-
LOCALE_USER_DEFAULT
-
既定のユーザー ロケール。
dwFlags [in]
型: DWORD
さまざまな関数オプションを指定します。 pwzFormat が NULL でない場合、このパラメーターは 0 である必要があります。 pwzFormat が NULL の場合は、次の値の組み合わせを指定できます。 DATE_YEARMONTH、DATE_SHORTDATE、またはDATE_LONGDATEを指定せず、 pwzFormat が NULL の場合、DATE_SHORTDATEが既定値として使用されます。
LOCALE_NOUSEROVERRIDE
設定されている場合、関数は、指定されたロケールのシステムの既定の日付形式を使用して文字列の書式を設定します。 設定されていない場合、関数は、ロケールの既定の日付形式に対するユーザー オーバーライドを使用して文字列の書式を設定します。
LOCALE_USE_CP_ACP
ロケールのコード ページではなく、文字列変換にシステム ANSI コード ページを使用します。
DATE_SHORTDATE
短い日付形式を使用します。 この値は、DATE_LONGDATEまたはDATE_YEARMONTHでは使用できません。
DATE_LONGDATE
長い日付形式を使用します。 この値は、DATE_SHORTDATEまたはDATE_YEARMONTHでは使用できません。
DATE_YEARMONTH
年/月形式を使用します。 この値は、DATE_SHORTDATEまたはDATE_LONGDATEでは使用できません。
DATE_USE_ALT_CALENDAR
代替カレンダーが存在する場合は、日付文字列の書式を設定するために使用します。 このフラグが設定されている場合、関数は、ユーザーオーバーライドを使用するのではなく、その代替カレンダーの既定の形式を使用します。 ユーザーのオーバーライドは、指定した代替カレンダーの既定の形式がない場合にのみ使用されます。
DATE_LTRREADING
左から右の読み取りレイアウトのマークを追加します。 この値は、DATE_RTLREADINGでは使用できません。
DATE_RTLREADING
右から左への読み取りレイアウトのマークを追加します。 この値は、DATE_LTRREADINGでは使用できません。
lpDate [in]
型: const SYSTEMTIME*
書式設定する日付情報を含む SYSTEMTIME 構造体へのポインター。 このポインターが NULL の場合、関数は現在のローカル システム日付を使用します。
pwzFormat [in]
種類: LPCWSTR
日付文字列の形成に使用する書式図へのポインター。 pwzFormat が NULL の場合、関数は指定されたロケールの日付形式を使用します。 詳細については、「 GetDateFormat 」を参照してください。
pwzDateStr [out]
種類: LPWSTR
書式設定された日付文字列を受け取るバッファーへのポインター。
cchDate [in]
型: int
pwzDateStr バッファーのサイズを文字単位で指定します。 cchDate が 0 の場合、関数は書式設定された日付文字列を保持するために必要な文字数を返し、pwzDateStr が指すバッファーは使用されません。
戻り値
型: int
関数が成功した場合、戻り値は pwzDateStr によって指されるバッファーに書き込まれた文字数です。 cchDate パラメーターが 0 の場合、戻り値は書式設定された日付文字列を保持するために必要な文字数です。 カウントには、終端の null 文字が含まれます。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。 GetLastError は 、次のいずれかのエラー コードを返す場合があります。
-
ERROR_INSUFFICIENT_BUFFER
-
ERROR_INVALID_FLAGS
-
ERROR_INVALID_PARAMETER
注釈
GetDateFormatWrapW は、Windows XP より前のオペレーティング システムで Unicode 文字列を使用する機能を提供します。 推奨される方法は、 GetDateFormatW を Microsoft Layer for Unicode (MSLU) と組み合わせて使用することです。
GetDateFormatWrapW は、序数 311 を使用して、Shlwapi.dllから直接呼び出す必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows 2000 Professional、Windows XP [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows Server 2003 [デスクトップ アプリのみ] |
| [DLL] |
|
こちらもご覧ください