GetDateFormatWrapW 函式
[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,這個參數必須是零。 如果 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 為零,函式會傳回保存格式化日期字串所需的字元數,而且不會使用 pwzDateStr 所指向的緩衝區。
類型: int
如果函式成功,則傳回值是 寫入 pwzDateStr所指向之緩衝區的字元數。 如果 cchDate 參數為零,則傳回值是保存格式化日期字串所需的字元數。 計數包含終止 Null 字元。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。 GetLastError 可能會傳回下列其中一個錯誤碼。
-
ERROR_INSUFFICIENT_BUFFER
-
ERROR_INVALID_FLAGS
-
ERROR_INVALID_PARAMETER
GetDateFormatWrapW 可讓您在 Windows XP 之前的作業系統中使用 Unicode 字串。 慣用的方法是搭配適用于 Unicode 的 Microsoft Layer (MSLU) 使用 GetDateFormatW 。
必須使用序數 311 直接從Shlwapi.dll呼叫GetDateFormatWrapW。
需求 | 值 |
---|---|
最低支援的用戶端 |
Windows 2000 專業版、Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 |
Windows Server 2003 [僅限傳統型應用程式] |
DLL |
|