GetGeoInfoW

関数

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

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

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

INT GetGeoInfoW(
    INT Location,
    SYSGEOTYPE GeoType,
    LPWSTR 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	LPWSTR	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

公式ドキュメント

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

戻り値

出力バッファーに取得された地理的位置情報のバイト数 (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 を指定した場合も、関数は "en-US" を lpGeoData に書き込みます。

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

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

メモ

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

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

INT GetGeoInfoW(
    INT Location,
    SYSGEOTYPE GeoType,
    LPWSTR lpGeoData,   // optional
    INT cchData,
    WORD LangId
);

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

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

' Location : INT
' GeoType : SYSGEOTYPE
' lpGeoData : LPWSTR optional, out
' cchData : INT
' LangId : WORD
Declare PtrSafe Function GetGeoInfoW Lib "kernel32" ( _
    ByVal Location As Long, _
    ByVal GeoType As Long, _
    ByVal lpGeoData As LongPtr, _
    ByVal cchData As Long, _
    ByVal LangId As Integer) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetGeoInfoW = ctypes.windll.kernel32.GetGeoInfoW
GetGeoInfoW.restype = ctypes.c_int
GetGeoInfoW.argtypes = [
    ctypes.c_int,  # Location : INT
    ctypes.c_int,  # GeoType : SYSGEOTYPE
    wintypes.LPWSTR,  # lpGeoData : LPWSTR 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')
GetGeoInfoW = Fiddle::Function.new(
  lib['GetGeoInfoW'],
  [
    Fiddle::TYPE_INT,  # Location : INT
    Fiddle::TYPE_INT,  # GeoType : SYSGEOTYPE
    Fiddle::TYPE_VOIDP,  # lpGeoData : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchData : INT
    -Fiddle::TYPE_SHORT,  # LangId : WORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetGeoInfoW(
        Location: i32,  // INT
        GeoType: i32,  // SYSGEOTYPE
        lpGeoData: *mut u16,  // LPWSTR 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.Unicode, SetLastError = true)]
public static extern int GetGeoInfoW(int Location, int GeoType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpGeoData, int cchData, ushort LangId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetGeoInfoW' -Namespace Win32 -PassThru
# $api::GetGeoInfoW(Location, GeoType, lpGeoData, cchData, LangId)

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

出力引数:

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