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

SetUserGeoID

関数
ユーザーの地理的位置識別子を設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetUserGeoID(
    INT GeoId
);

パラメーター

名前方向説明
GeoIdINTinユーザーの地理的位置を表す識別子。

戻り値の型: BOOL

公式ドキュメント

ユーザーの地理的位置識別子を設定します。この識別子には、「Table of Geographical Locations」で説明されている値のいずれかを指定する必要があります。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。

Windows XP, Windows Server 2003: この関数は拡張エラー情報を提供しません。そのため、この関数の呼び出し後にアプリケーションが GetLastError を呼び出すことは適切ではありません。アプリケーションが GetLastError を呼び出した場合、以前に呼び出された別の関数によって設定された値が返される可能性があります。

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

解説(Remarks)

この関数は、特定のアプリケーションではなく特定のユーザーの地理的位置をレジストリに書き込みます。この操作は、そのユーザーが実行する他のアプリケーションの動作に影響します。原則として、アプリケーションは、ユーザーが明示的に変更を要求した場合にのみこの関数を呼び出すべきであり、純粋にアプリケーション固有の理由で呼び出すべきではありません。

SetUserGeoID は、Windows の設定など、ユーザー設定を変更するように設計されたアプリケーションでの使用を想定しています。その他のアプリケーションはこの関数を呼び出すべきではありません。

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

各言語での呼び出し定義

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

BOOL SetUserGeoID(
    INT GeoId
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetUserGeoID(
    int GeoId   // INT
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetUserGeoID(
    GeoId As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' GeoId : INT
Declare PtrSafe Function SetUserGeoID Lib "kernel32" ( _
    ByVal GeoId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetUserGeoID = ctypes.windll.kernel32.SetUserGeoID
SetUserGeoID.restype = wintypes.BOOL
SetUserGeoID.argtypes = [
    ctypes.c_int,  # GeoId : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetUserGeoID = Fiddle::Function.new(
  lib['SetUserGeoID'],
  [
    Fiddle::TYPE_INT,  # GeoId : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetUserGeoID(
        GeoId: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetUserGeoID(int GeoId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetUserGeoID' -Namespace Win32 -PassThru
# $api::SetUserGeoID(GeoId)
#uselib "KERNEL32.dll"
#func global SetUserGeoID "SetUserGeoID" sptr
; SetUserGeoID GeoId   ; 戻り値は stat
; GeoId : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetUserGeoID "SetUserGeoID" int
; res = SetUserGeoID(GeoId)
; GeoId : INT -> "int"
; BOOL SetUserGeoID(INT GeoId)
#uselib "KERNEL32.dll"
#cfunc global SetUserGeoID "SetUserGeoID" int
; res = SetUserGeoID(GeoId)
; GeoId : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetUserGeoID = kernel32.NewProc("SetUserGeoID")
)

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

extern "kernel32" fn SetUserGeoID(
    GeoId: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc SetUserGeoID(
    GeoId: int32  # INT
): int32 {.importc: "SetUserGeoID", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetUserGeoID(
    int GeoId   // INT
);
ccall((:SetUserGeoID, "KERNEL32.dll"), stdcall, Int32,
      (Int32,),
      GeoId)
# GeoId : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetUserGeoID(
    int32_t GeoId);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetUserGeoID(GeoId)
-- GeoId : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetUserGeoID = lib.func('__stdcall', 'SetUserGeoID', 'int32_t', ['int32_t']);
// SetUserGeoID(GeoId)
// GeoId : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetUserGeoID: { parameters: ["i32"], result: "i32" },
});
// lib.symbols.SetUserGeoID(GeoId)
// GeoId : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetUserGeoID(
    int32_t GeoId);
C, "KERNEL32.dll");
// $ffi->SetUserGeoID(GeoId);
// GeoId : 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);
    boolean SetUserGeoID(
        int GeoId   // INT
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetUserGeoID = SetUserGeoID(
    GeoId : 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 SetUserGeoIDNative = Int32 Function(Int32);
typedef SetUserGeoIDDart = int Function(int);
final SetUserGeoID = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetUserGeoIDNative, SetUserGeoIDDart>('SetUserGeoID');
// GeoId : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetUserGeoID(
  GeoId: Integer   // INT
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetUserGeoID';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetUserGeoID"
  c_SetUserGeoID :: Int32 -> IO CInt
-- GeoId : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setusergeoid =
  foreign "SetUserGeoID"
    (int32_t @-> returning int32_t)
(* GeoId : 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 ("SetUserGeoID" set-user-geo-id :convention :stdcall) :int32
  (geo-id :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetUserGeoID = Win32::API::More->new('KERNEL32',
    'BOOL SetUserGeoID(int GeoId)');
# my $ret = $SetUserGeoID->Call($GeoId);
# GeoId : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目