LCIDToLocaleName 函式 (winnls.h)
注意 針對自定義地區設定,包括 Microsoft 所建立的地區設定,您的應用程式應該偏好地區設定名稱而非地區設定標識符。
語法
int LCIDToLocaleName(
[in] LCID Locale,
[out, optional] LPWSTR lpName,
[in] int cchName,
[in] DWORD dwFlags
);
參數
[in] Locale
要轉譯的地區設定標識碼。 您可以使用 MAKELCID 宏來建立地區設定標識碼,或使用下列其中一個預先定義的值。
Windows Vista: 也支援下列自定義地區設定標識碼。[out, optional] lpName
此函式擷取地區設定名稱或下列其中一個預先定義值的緩衝區指標。
[in] cchName
地區設定名稱緩衝區的大小,以字元為單位。 地區設定名稱的可能長度上限,包括終止的 Null 字元是 LOCALE_NAME_MAX_LENGTH。 這是為此參數提供的建議大小。
或者,應用程式可以將此參數設定為 0。 在此情況下,函式會傳回地區設定名稱緩衝區所需的大小。
[in] dwFlags
在 Windows 7 之前: 保留;應一律為 0。
從 Windows 7 開始: 可以設定為 LOCALE_ALLOW_NEUTRAL_NAMES ,以允許傳回中性名稱。
傳回值
如果成功,則會傳回地區設定名稱中的字元計數,包括終止的 Null 字元。 如果函式成功, 且 cchName 的值為 0,則傳回值是所需的大小,以字元為單位, (包括地區設定名稱緩衝區的 nulls) 。
如果函式不成功,函式會傳回 0。 若要取得擴充的錯誤資訊,應用程式可以呼叫 GetLastError,這可以傳回下列其中一個錯誤碼:
- ERROR_INSUFFICIENT_BUFFER。 提供的緩衝區大小不夠大,或設定為 NULL 不正確。
- ERROR_INVALID_PARAMETER。 任何參數值都無效。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2008 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | winnls.h (包含 Windows.h) |
程式庫 | Kernel32.lib |
DLL | Kernel32.dll |