GetGeoInfoA

関数

指定地域識別子の地理情報を取得する。ANSI版。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

INT GetGeoInfoA(
    INT Location,
    SYSGEOTYPE GeoType,
    LPSTR lpGeoData,   // optional
    INT cchData,
    WORD LangId
);

パラメーター

名前	型	方向	説明
Location	INT	in	情報を取得する対象となる地理的位置の識別子。詳細については、地理的位置の一覧表を参照してください。利用可能な値は、EnumSystemGeoID を呼び出すことで取得できます。
GeoType	SYSGEOTYPE	in	取得する情報の種類。指定できる値は SYSGEOTYPE 列挙体によって定義されます。GeoType の値が GEO_LCID の場合、この関数はロケール識別子を取得します。GeoType の値が GEO_RFC1766 の場合、この関数は RFC 4646 (Windows Vista) に準拠した文字列名を取得します。詳細については、「解説」セクションを参照してください。 Windows XP: GeoType が GEO_LCID に設定されている場合、取得される文字列は 8 桁の 16 進数値です。 Windows Me: GeoType が GEO_LCID に設定されている場合、取得される文字列は 10 進数値です。
lpGeoData	LPSTR	outoptional	この関数が情報を取得して格納するバッファーへのポインター。
cchData	INT	in	lpGeoData で指定されるバッファーのサイズ。このサイズは、関数の ANSI 版ではバイト数、Unicode 版ではワード数です。関数に必要なバッファーサイズを返させたい場合、アプリケーションはこのパラメーターを 0 に設定できます。
LangId	WORD	in	言語の識別子。Location の値と組み合わせて使用します。GeoType に GEO_RFC1766 または GEO_LCID を指定している場合、アプリケーションはこのパラメーターを 0 に設定できます。この設定により、関数は GetUserDefaultLangID を呼び出して言語識別子を取得します。注意 GeoType が GEO_RFC1766 または GEO_LCID 以外の値を持つ場合、アプリケーションはこのパラメーターを 0 に設定する必要があります。

戻り値の型: INT

公式ドキュメント

指定した地理的位置に関する情報を取得します。(ANSI)

戻り値

出力バッファーに取得された地理的位置情報のバイト数 (ANSI) またはワード数 (Unicode) を返します。cchData が 0 に設定されている場合、関数はバッファーに必要なサイズを返します。

関数が成功しなかった場合は 0 を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができます。この関数は次のいずれかのエラーコードを返す可能性があります。

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分に大きくなかったか、誤って NULL に設定されていました。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

アプリケーションが GeoType に GEO_RFC1766 を指定する場合、指定した地理的位置識別子に適した言語識別子を LangId に指定する必要があります。適切な言語とは、ロケールに依存しない言語、または指定した識別子に対応するロケールを持つ言語のいずれかです。結果として得られる RFC 4646 (Windows Vista) 準拠の文字列は、ロケール名を構成します。

たとえば、Location にアメリカ合衆国を表す 0xF4 を指定し、GeoType に GEO_RFC1766 を指定し、LangId にロケールに依存しない英語を表す 0x09 または英語 (米国) を表す 0x409 のいずれかを指定した場合、関数は正常終了時に "en-US" を取得します。実際には、関数は言語のうちロケール固有の部分を無視します。したがって、アプリケーションが LangId に英語 (英国) を表す 0x809 を指定した場合でも、関数は lpGeoData に "en-US" を書き込みます。

もう 1 つの例を考えます。Location にアメリカ合衆国を表す 0xF4 を指定し、GeoType に GEO_RFC1766 を指定し、LangId に中国語を表す 0x04 を指定した場合、関数は正常終了時に "zh-US" を取得します。これはサポートされているロケールの名前ではありません。

アプリケーションが GeoType に GEO_LCID を指定する場合、関数は言語識別子をロケール識別子 (LCID) として扱います。提供された地理的識別子と何らかの形で関連付けられているロケール識別子が存在する場合、関数はそれを返そうとします。

メモ

winnls.h ヘッダーは GetGeoInfo を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディングに依存しないこのエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

INT GetGeoInfoA(
    INT Location,
    SYSGEOTYPE GeoType,
    LPSTR lpGeoData,   // optional
    INT cchData,
    WORD LangId
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int GetGeoInfoA(
    int Location,   // INT
    int GeoType,   // SYSGEOTYPE
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpGeoData,   // LPSTR optional, out
    int cchData,   // INT
    ushort LangId   // WORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetGeoInfoA(
    Location As Integer,   ' INT
    GeoType As Integer,   ' SYSGEOTYPE
    <MarshalAs(UnmanagedType.LPStr)> lpGeoData As System.Text.StringBuilder,   ' LPSTR optional, out
    cchData As Integer,   ' INT
    LangId As UShort   ' WORD
) As Integer
End Function

' Location : INT
' GeoType : SYSGEOTYPE
' lpGeoData : LPSTR optional, out
' cchData : INT
' LangId : WORD
Declare PtrSafe Function GetGeoInfoA Lib "kernel32" ( _
    ByVal Location As Long, _
    ByVal GeoType As Long, _
    ByVal lpGeoData As String, _
    ByVal cchData As Long, _
    ByVal LangId As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetGeoInfoA = ctypes.windll.kernel32.GetGeoInfoA
GetGeoInfoA.restype = ctypes.c_int
GetGeoInfoA.argtypes = [
    ctypes.c_int,  # Location : INT
    ctypes.c_int,  # GeoType : SYSGEOTYPE
    wintypes.LPSTR,  # lpGeoData : LPSTR optional, out
    ctypes.c_int,  # cchData : INT
    ctypes.c_ushort,  # LangId : WORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetGeoInfoA = Fiddle::Function.new(
  lib['GetGeoInfoA'],
  [
    Fiddle::TYPE_INT,  # Location : INT
    Fiddle::TYPE_INT,  # GeoType : SYSGEOTYPE
    Fiddle::TYPE_VOIDP,  # lpGeoData : LPSTR optional, out
    Fiddle::TYPE_INT,  # cchData : INT
    -Fiddle::TYPE_SHORT,  # LangId : WORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetGeoInfoA(
        Location: i32,  // INT
        GeoType: i32,  // SYSGEOTYPE
        lpGeoData: *mut u8,  // LPSTR optional, out
        cchData: i32,  // INT
        LangId: u16  // WORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int GetGeoInfoA(int Location, int GeoType, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpGeoData, int cchData, ushort LangId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetGeoInfoA' -Namespace Win32 -PassThru
# $api::GetGeoInfoA(Location, GeoType, lpGeoData, cchData, LangId)

#uselib "KERNEL32.dll"
#func global GetGeoInfoA "GetGeoInfoA" sptr, sptr, sptr, sptr, sptr
; GetGeoInfoA Location, GeoType, varptr(lpGeoData), cchData, LangId   ; 戻り値は stat
; Location : INT -> "sptr"
; GeoType : SYSGEOTYPE -> "sptr"
; lpGeoData : LPSTR optional, out -> "sptr"
; cchData : INT -> "sptr"
; LangId : WORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetGeoInfoA "GetGeoInfoA" int, int, var, int, int
; res = GetGeoInfoA(Location, GeoType, lpGeoData, cchData, LangId)
; Location : INT -> "int"
; GeoType : SYSGEOTYPE -> "int"
; lpGeoData : LPSTR optional, out -> "var"
; cchData : INT -> "int"
; LangId : WORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetGeoInfoA "GetGeoInfoA" int, int, sptr, int, int
; res = GetGeoInfoA(Location, GeoType, varptr(lpGeoData), cchData, LangId)
; Location : INT -> "int"
; GeoType : SYSGEOTYPE -> "int"
; lpGeoData : LPSTR optional, out -> "sptr"
; cchData : INT -> "int"
; LangId : WORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。