GetGeoInfoA 函式（winnls.h）

發行項
11/20/2024

[GetGeoInfo 可用於需求一節中指定的作業系統。後續版本可能會變更或無法使用。請改用 GetGeoInfoEx。

]

擷取指定地理位置的相關信息。

語法

int GetGeoInfoA(
  [in]            GEOID   Location,
  [in]            GEOTYPE GeoType,
  [out, optional] LPSTR   lpGeoData,
  [in]            int     cchData,
  [in]            LANGID  LangId
);

參數

[in] Location

要取得資訊的地理位置標識碼。如需詳細資訊，請參閱地理位置資料表。您可以呼叫 EnumSystemGeoID來取得可用的值。

[in] GeoType

要擷取的信息類型。可能的值是由 SYSGEOTYPE 列舉所定義。如果 GeoType 的值是GEO_LCID，函式會擷取地區設定標識符。如果 GeoType 的值是GEO_RFC1766，函式會擷取符合 RFC 4646 （Windows Vista）的字串名稱。如需詳細資訊，請參閱一節。

Windows XP： 當 geoType 設定為 GEO_LCID 時，擷取的字元串是 8 位數的十六進位值。

Windows Me： 當 GeoType 設定為 GEO_LCID 時，擷取的字元串是十進位值。

[out, optional] lpGeoData

這個函式擷取信息的緩衝區指標。

[in] cchData

lpGeoData 所指示的緩衝區大小。大小是函式 ANSI 版本的位元元數目，或 Unicode 版本的字數。如果函式傳回所需的緩衝區大小，應用程式可以將此參數設定為 0。

[in] LangId

語言的標識碼，與 Location的值搭配使用。應用程式可以將此參數設定為 0，並針對 GeoType指定GEO_RFC1766或GEO_LCID。此設定會藉由呼叫 getUserDefaultLangID呼叫，來擷取語言標識碼。

附註如果 GeoType 具有GEO_RFC1766或GEO_LCID以外的任何值，應用程式就必須將此參數設定為 0。

傳回值

傳回輸出緩衝區中擷取之地理位置資訊的位元元組數（ANSI）或單字（Unicode）。如果 cchData 設為 0，函式會傳回緩衝區所需的大小。

如果函式未成功，則傳回 0。若要取得擴充的錯誤資訊，應用程式可以呼叫 getLastError，以傳回下列其中一個錯誤碼：

ERROR_INSUFFICIENT_BUFFER。提供的緩衝區大小不夠大，或設定為 NULL不正確。
ERROR_INVALID_PARAMETER。任何參數值都無效。

言論

如果應用程式指定 GeoType的GEO_RFC1766，它應該為適用於指定地理位置標識符的 LangId 指定語言識別碼。適當的語言是地區設定中性語言，或是具有對應至指定標識符的地區設定。產生的字串，符合 RFC 4646 （Windows Vista），構成地區設定名稱。

例如，如果位置指定為美國0xF4，GeoType 指定為GEO_RFC1766，且 LangId 指定為地區設定中性英文或英文0x409 0x09，則函式會在成功傳回時擷取 “en-US”。事實上，函式會忽略語言的地區設定特定部分。因此，如果應用程式將 LangId 指定為英文0x809（英國），函式也會將 “en-US”寫入 lpGeoData。

請考慮另一個範例。如果位置指定為美國0xF4，GeoType 會指定為 GEO_RFC1766，且 LangId 指定為中文0x04，則函式會在成功傳回時擷取 “zh-US”。這不是支援的地區設定名稱。

如果應用程式指定 GeoType的GEO_LCID，則函式會將語言標識碼視為地區設定標識碼（LCID）。如果地區設定標識碼以某種方式與提供的地理標識符相關聯，它會嘗試傳回地區設定標識符。

注意

winnls.h 標頭會將 GetGeoInfo 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

要求

要求	價值
最低支援的用戶端	Windows XP [傳統型應用程式 \|UWP 應用程式]
支援的最低伺服器	Windows Server 2003 [傳統型應用程式 \|UWP 應用程式]
目標平臺	窗戶
標頭	winnls.h （包括 Windows.h）
連結庫	Kernel32.lib
DLL	Kernel32.dll