GetGeoInfoW 関数 (winnls.h)
[GetGeoInfo は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、 GetGeoInfoEx を使用します。
]
指定した地理的な場所に関する情報を取得します。
構文
int GetGeoInfoW(
[in] GEOID Location,
[in] GEOTYPE GeoType,
[out, optional] LPWSTR 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 桁の 16 進数の値になります。
Windows Me:GeoType が GEO_LCID に設定されている場合、取得される文字列は 10 進数の値になります。
[out, optional] lpGeoData
この関数が情報を取得するバッファーへのポインター。
[in] cchData
lpGeoData で示されるバッファーのサイズ。 サイズは、ANSI バージョンの関数のバイト数、または Unicode バージョンの単語数です。 関数がバッファーの必要なサイズを返す場合、アプリケーションはこのパラメーターを 0 に設定できます。
[in] LangId
Location の値と共に使用される言語の識別子。 アプリケーションでは、このパラメーターを 0 に設定し、 geoType にGEO_RFC1766またはGEO_LCID指定できます。 この設定により、 関数は GetUserDefaultLangID を呼び出して言語識別子を取得します。
戻り値
出力バッファーで取得された地理的位置情報のバイト数 (ANSI) または単語 (Unicode) を返します。 cchData が 0 に設定されている場合、関数はバッファーに必要なサイズを返します。
成功しなかった場合、関数は 0 を返します。 拡張エラー情報を取得するために、アプリケーションは GetLastError を呼び出すことができます。これにより、次のいずれかのエラー コードが返されます。
- ERROR_INSUFFICIENT_BUFFER。 指定されたバッファー サイズが十分に大きくなかったか、 正しく NULL に設定されていませんでした。
- ERROR_INVALID_PARAMETER。 パラメーター値のいずれかが無効です。
解説
アプリケーションで GeoType のGEO_RFC1766を指定する場合は、指定した地理的な場所の識別子に適した 言語識別子を LangId に指定する必要があります。 適切な言語は、ロケールに依存しない言語か、指定した識別子に対応するロケールを持つ言語です。 RFC 4646 (Windows Vista) に準拠した結果の文字列は 、ロケール名を構成します。
たとえば、Location が米国の0xF4として指定されている場合、GeoType は GEO_RFC1766 として指定され、LangId はロケールに依存しない英語の場合は0x09として指定され、英語 (米国) には 0x409 として指定されます。関数は正常に戻ると "en-US" を取得します。 実際、関数は言語のロケール固有の部分を無視します。 したがって、アプリケーションで LangId が英語 (英国) の0x809として指定されている場合、この関数は lpGeoData にも "en-US" を書き込みます。
別の例を見てみましょう。 Location が米国の0xF4として指定され、GeoType が GEO_RFC1766 として指定され、LangId が中国語の場合は 0x04 として指定されている場合、関数は正常に戻ると "zh-US" を取得します。 これは、サポートされているロケールの名前ではありません。
アプリケーションで GeoType のGEO_LCIDが指定されている場合、関数は言語識別子をロケール識別子 (LCID) として扱います。 指定された地理的識別子に何らかの方法で関連付けられている場合は、ロケール識別子を返そうとします。
注意
winnls.h ヘッダーは、GetGeoInfo をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows XP [デスクトップ アプリ | UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winnls.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |