Win32 API 日本語リファレンス
ホームGlobalization › GetUserDefaultGeoName

GetUserDefaultGeoName

関数
ユーザー既定の地理的位置名を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 10 以降

シグネチャ

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

INT GetUserDefaultGeoName(
    LPWSTR geoName,
    INT geoNameCount
);

パラメーター

名前方向説明
geoNameLPWSTRoutこの関数が、null 終端の ISO 3166-1 の 2 文字コードまたは国連 (UN) Series M, Number 49 (M.49) の数値コードを書き込むバッファーへのポインター。
geoNameCountINTingeoName パラメーターで指定したバッファーのサイズ。この値が 0 の場合、関数は出力バッファーにコピーする文字数を返すだけで、ユーザーの既定の地理的位置の名前をバッファーに書き込みません。

戻り値の型: INT

公式ドキュメント

ユーザーの既定の地理的位置に対応する、ISO 3166-1 の 2 文字コード、または国連 (UN) Series M, Number 49 (M.49) の数値コードを取得します。

戻り値

geoNameCount パラメーターの値が 0 の場合は、関数が出力バッファーにコピーする文字数。それ以外の場合は、geoName パラメーターで指定したバッファーに関数がコピーした文字数。

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

戻りコード 説明
ERROR_INVALID_PARAMETER パラメーター値が無効でした。
ERROR_BADDB 関数がレジストリから情報を読み取れませんでした。
ERROR_INSUFFICIENT_BUFFER geoName パラメーターで指定したバッファーが文字列に対して小さすぎます。

解説(Remarks)

ユーザーの既定の地理的位置に対応する ISO 3166-1 コードが 'XX'(コードが割り当てられていないことを示す)であっても、その位置に UN M.49 コードが割り当てられている場合は、M.49 コードが 10 進数の文字列として返されます。

2 文字の ISO 3166-1 コードについては、ISO 3166 Country Codes を参照してください。

数値の 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 GetUserDefaultGeoName(
    LPWSTR geoName,
    INT geoNameCount
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetUserDefaultGeoName(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder geoName,   // LPWSTR out
    int geoNameCount   // INT
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUserDefaultGeoName(
    <MarshalAs(UnmanagedType.LPWStr)> geoName As System.Text.StringBuilder,   ' LPWSTR out
    geoNameCount As Integer   ' INT
) As Integer
End Function
' geoName : LPWSTR out
' geoNameCount : INT
Declare PtrSafe Function GetUserDefaultGeoName Lib "kernel32" ( _
    ByVal geoName As LongPtr, _
    ByVal geoNameCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetUserDefaultGeoName = ctypes.windll.kernel32.GetUserDefaultGeoName
GetUserDefaultGeoName.restype = ctypes.c_int
GetUserDefaultGeoName.argtypes = [
    wintypes.LPWSTR,  # geoName : LPWSTR out
    ctypes.c_int,  # geoNameCount : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetUserDefaultGeoName = Fiddle::Function.new(
  lib['GetUserDefaultGeoName'],
  [
    Fiddle::TYPE_VOIDP,  # geoName : LPWSTR out
    Fiddle::TYPE_INT,  # geoNameCount : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetUserDefaultGeoName(
        geoName: *mut u16,  // LPWSTR out
        geoNameCount: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int GetUserDefaultGeoName([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder geoName, int geoNameCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetUserDefaultGeoName' -Namespace Win32 -PassThru
# $api::GetUserDefaultGeoName(geoName, geoNameCount)
#uselib "KERNEL32.dll"
#func global GetUserDefaultGeoName "GetUserDefaultGeoName" sptr, sptr
; GetUserDefaultGeoName varptr(geoName), geoNameCount   ; 戻り値は stat
; geoName : LPWSTR out -> "sptr"
; geoNameCount : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetUserDefaultGeoName "GetUserDefaultGeoName" var, int
; res = GetUserDefaultGeoName(geoName, geoNameCount)
; geoName : LPWSTR out -> "var"
; geoNameCount : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT GetUserDefaultGeoName(LPWSTR geoName, INT geoNameCount)
#uselib "KERNEL32.dll"
#cfunc global GetUserDefaultGeoName "GetUserDefaultGeoName" var, int
; res = GetUserDefaultGeoName(geoName, geoNameCount)
; geoName : LPWSTR out -> "var"
; geoNameCount : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetUserDefaultGeoName = kernel32.NewProc("GetUserDefaultGeoName")
)

// geoName (LPWSTR out), geoNameCount (INT)
r1, _, err := procGetUserDefaultGeoName.Call(
	uintptr(geoName),
	uintptr(geoNameCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function GetUserDefaultGeoName(
  geoName: PWideChar;   // LPWSTR out
  geoNameCount: Integer   // INT
): Integer; stdcall;
  external 'KERNEL32.dll' name 'GetUserDefaultGeoName';
result := DllCall("KERNEL32\GetUserDefaultGeoName"
    , "Ptr", geoName   ; LPWSTR out
    , "Int", geoNameCount   ; INT
    , "Int")   ; return: INT
●GetUserDefaultGeoName(geoName, geoNameCount) = DLL("KERNEL32.dll", "int GetUserDefaultGeoName(char*, int)")
# 呼び出し: GetUserDefaultGeoName(geoName, geoNameCount)
# geoName : LPWSTR out -> "char*"
# geoNameCount : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn GetUserDefaultGeoName(
    geoName: [*c]u16, // LPWSTR out
    geoNameCount: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc GetUserDefaultGeoName(
    geoName: ptr uint16,  # LPWSTR out
    geoNameCount: int32  # INT
): int32 {.importc: "GetUserDefaultGeoName", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetUserDefaultGeoName(
    wchar* geoName,   // LPWSTR out
    int geoNameCount   // INT
);
ccall((:GetUserDefaultGeoName, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{UInt16}, Int32),
      geoName, geoNameCount)
# geoName : LPWSTR out -> Ptr{UInt16}
# geoNameCount : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetUserDefaultGeoName(
    uint16_t* geoName,
    int32_t geoNameCount);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetUserDefaultGeoName(geoName, geoNameCount)
-- geoName : LPWSTR out
-- geoNameCount : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetUserDefaultGeoName = lib.func('__stdcall', 'GetUserDefaultGeoName', 'int32_t', ['uint16_t *', 'int32_t']);
// GetUserDefaultGeoName(geoName, geoNameCount)
// geoName : LPWSTR out -> 'uint16_t *'
// geoNameCount : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetUserDefaultGeoName: { parameters: ["buffer", "i32"], result: "i32" },
});
// lib.symbols.GetUserDefaultGeoName(geoName, geoNameCount)
// geoName : LPWSTR out -> "buffer"
// geoNameCount : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetUserDefaultGeoName(
    uint16_t* geoName,
    int32_t geoNameCount);
C, "KERNEL32.dll");
// $ffi->GetUserDefaultGeoName(geoName, geoNameCount);
// geoName : LPWSTR out
// geoNameCount : INT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    int GetUserDefaultGeoName(
        char[] geoName,   // LPWSTR out
        int geoNameCount   // INT
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetUserDefaultGeoName = GetUserDefaultGeoName(
    geoName : UInt16*,   # LPWSTR out
    geoNameCount : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetUserDefaultGeoNameNative = Int32 Function(Pointer<Utf16>, Int32);
typedef GetUserDefaultGeoNameDart = int Function(Pointer<Utf16>, int);
final GetUserDefaultGeoName = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetUserDefaultGeoNameNative, GetUserDefaultGeoNameDart>('GetUserDefaultGeoName');
// geoName : LPWSTR out -> Pointer<Utf16>
// geoNameCount : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetUserDefaultGeoName(
  geoName: PWideChar;   // LPWSTR out
  geoNameCount: Integer   // INT
): Integer; stdcall;
  external 'KERNEL32.dll' name 'GetUserDefaultGeoName';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetUserDefaultGeoName"
  c_GetUserDefaultGeoName :: CWString -> Int32 -> IO Int32
-- geoName : LPWSTR out -> CWString
-- geoNameCount : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getuserdefaultgeoname =
  foreign "GetUserDefaultGeoName"
    ((ptr uint16_t) @-> int32_t @-> returning int32_t)
(* geoName : LPWSTR out -> (ptr uint16_t) *)
(* geoNameCount : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetUserDefaultGeoName" get-user-default-geo-name :convention :stdcall) :int32
  (geo-name :pointer)   ; LPWSTR out
  (geo-name-count :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetUserDefaultGeoName = Win32::API::More->new('KERNEL32',
    'int GetUserDefaultGeoName(LPWSTR geoName, int geoNameCount)');
# my $ret = $GetUserDefaultGeoName->Call($geoName, $geoNameCount);
# geoName : LPWSTR out -> LPWSTR
# geoNameCount : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。