GetGeoInfoEx

関数

地域名を指定して地理情報を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 10 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

INT GetGeoInfoEx(
    LPWSTR location,
    SYSGEOTYPE geoType,
    LPWSTR geoData,   // optional
    INT geoDataCount
);

パラメーター

名前	型	方向	説明
location	LPWSTR	in	情報を取得する地理的位置を表す 2 文字の ISO 3166-1 コード、または数値の UN M.49 コードです。オペレーティングシステムで利用可能なコードを取得するには、EnumSystemGeoNames を呼び出します。
geoType	SYSGEOTYPE	in	取得する情報の種類です。指定可能な値は SYSGEOTYPE 列挙体で定義されています。SYSGEOTYPE 列挙体の次の値は GetGeoInfoEx では使用しないでください。 GEO_ID この値は下位互換性のために提供されています。新しいアプリケーションではこの値を使用せず、代わりに GEO_NAME を使用してください。 GEO_LCID この値は GetGeoInfoEx 関数ではサポートされていません。 GEO_NATION この値は GetGeoInfoEx 関数ではサポートされていません。 GEO_RFC1766 この値は GetGeoInfoEx 関数ではサポートされていません。
geoData	LPWSTR	outoptional	GetGeoInfoEx が要求された情報を書き込むバッファーへのポインターです。
geoDataCount	INT	in	GeoData パラメーターが指すバッファーのサイズ (文字数単位) です。要求された情報をバッファーに書き込まず、その情報を格納するために必要なバッファーのサイズのみを関数に返させる場合は、このパラメーターに 0 を設定します。

戻り値の型: INT

公式ドキュメント

2文字の国際標準化機構 (ISO) 3166-1 コード、または数値の国際連合 (UN) Series M, Number 49 (M.49) コードで指定した地理的位置に関する情報を取得します。

戻り値

関数が出力バッファーに書き込んだ地理的位置情報のバイト数です。geoDataCount が 0 の場合、関数は情報をバッファーに書き込まずに、その情報を格納するために必要なバッファーのサイズを返します。

0 は関数が成功しなかったことを示します。拡張エラー情報を取得するには GetLastError を呼び出します。次のいずれかのエラーコードが返される可能性があります。

戻り値コード	説明
ERROR_INSUFFICIENT_BUFFER	指定されたバッファーサイズが十分な大きさではなかったか、誤って NULL に設定されていました。
ERROR_INVALID_PARAMETER	パラメーター値が無効でした。
ERROR_INVALID_FLAGS	フラグに指定された値が無効でした。

解説(Remarks)

2 文字の ISO 3166-1 コードについては、Country Codes - ISO 3166 を参照してください。数値の UN M.49 コードについては、Standard country or area codes for statistical use (M49) を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

INT GetGeoInfoEx(
    LPWSTR location,
    SYSGEOTYPE geoType,
    LPWSTR geoData,   // optional
    INT geoDataCount
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetGeoInfoEx(
    [MarshalAs(UnmanagedType.LPWStr)] string location,   // LPWSTR
    int geoType,   // SYSGEOTYPE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder geoData,   // LPWSTR optional, out
    int geoDataCount   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetGeoInfoEx(
    <MarshalAs(UnmanagedType.LPWStr)> location As String,   ' LPWSTR
    geoType As Integer,   ' SYSGEOTYPE
    <MarshalAs(UnmanagedType.LPWStr)> geoData As System.Text.StringBuilder,   ' LPWSTR optional, out
    geoDataCount As Integer   ' INT
) As Integer
End Function

' location : LPWSTR
' geoType : SYSGEOTYPE
' geoData : LPWSTR optional, out
' geoDataCount : INT
Declare PtrSafe Function GetGeoInfoEx Lib "kernel32" ( _
    ByVal location As LongPtr, _
    ByVal geoType As Long, _
    ByVal geoData As LongPtr, _
    ByVal geoDataCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetGeoInfoEx = ctypes.windll.kernel32.GetGeoInfoEx
GetGeoInfoEx.restype = ctypes.c_int
GetGeoInfoEx.argtypes = [
    wintypes.LPCWSTR,  # location : LPWSTR
    ctypes.c_int,  # geoType : SYSGEOTYPE
    wintypes.LPWSTR,  # geoData : LPWSTR optional, out
    ctypes.c_int,  # geoDataCount : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetGeoInfoEx = Fiddle::Function.new(
  lib['GetGeoInfoEx'],
  [
    Fiddle::TYPE_VOIDP,  # location : LPWSTR
    Fiddle::TYPE_INT,  # geoType : SYSGEOTYPE
    Fiddle::TYPE_VOIDP,  # geoData : LPWSTR optional, out
    Fiddle::TYPE_INT,  # geoDataCount : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetGeoInfoEx(
        location: *mut u16,  // LPWSTR
        geoType: i32,  // SYSGEOTYPE
        geoData: *mut u16,  // LPWSTR optional, out
        geoDataCount: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int GetGeoInfoEx([MarshalAs(UnmanagedType.LPWStr)] string location, int geoType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder geoData, int geoDataCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetGeoInfoEx' -Namespace Win32 -PassThru
# $api::GetGeoInfoEx(location, geoType, geoData, geoDataCount)

#uselib "KERNEL32.dll"
#func global GetGeoInfoEx "GetGeoInfoEx" sptr, sptr, sptr, sptr
; GetGeoInfoEx location, geoType, varptr(geoData), geoDataCount   ; 戻り値は stat
; location : LPWSTR -> "sptr"
; geoType : SYSGEOTYPE -> "sptr"
; geoData : LPWSTR optional, out -> "sptr"
; geoDataCount : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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