GetSystemDefaultLocaleName 函式 (winnls.h)
擷取系統預設 的地區設定名稱。
注意 建議應用程式在此函式的喜好設定上呼叫 GetUserDefaultLocaleName 。 這是因為用戶地區設定通常比系統地區設定更實用且更精確。
注意 如果設計為只在 Windows Vista 和更新版本上執行,應用程式應該優先呼叫此函式給 GetSystemDefaultLCID 。
語法
int GetSystemDefaultLocaleName(
[out] LPWSTR lpLocaleName,
[in] int cchLocaleName
);
參數
[out] lpLocaleName
這個函式擷取地區設定名稱之緩衝區的指標。
[in] cchLocaleName
大小,以字元為單位,為 lpLocaleName 所指示的輸出緩衝區。 地區設定名稱的最大可能字元長度 (包括終止 null 字元) 是 LOCALE_NAME_MAX_LENGTH的值。 這是建議的大小。
傳回值
傳回大於 0 的值,指出地區設定名稱的長度,包括如果成功,則包含終止 Null 字元。
如果函式未成功,此函式會傳回 0。 若要取得延伸的錯誤資訊,應用程式可以呼叫 GetLastError,這可以傳回下列其中一個錯誤碼:
- ERROR_INSUFFICIENT_BUFFER。 提供的緩衝區大小不夠大,或設定為 NULL 不正確。
備註
此函式可以從 自定義地區設定擷取數據。 數據不保證從計算機到計算機或在應用程式執行之間相同。 如果您的應用程式必須保存或傳輸數據,請參閱 使用持續性地區設定數據。
範例
此函式的使用範例可在 NLS:名稱型 API 範例中找到。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2008 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | winnls.h (包含 Windows.h) |
程式庫 | Kernel32.lib |
DLL | Kernel32.dll |