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

SetUserGeoName

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

シグネチャ

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

BOOL SetUserGeoName(
    LPWSTR geoName
);

パラメーター

名前方向説明
geoNameLPWSTRin現在のユーザーに設定する地理的位置を表す 2 文字の ISO 3166-1 コード、または数値の UN M.49 コード。オペレーティングシステムで利用可能なコードを取得するには、EnumSystemGeoNames を呼び出します。

戻り値の型: BOOL

公式ドキュメント

現在のユーザーの地理的位置を、指定された 2 文字の国際標準化機構 (ISO) 3166-1 コード、または数値による国際連合 (UN) Series M, Number 49 (M.49) コードに設定します。

戻り値

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

この関数が成功しなかった場合は GetLastError を呼び出してください。次のいずれかのエラーコードが返される可能性があります。

Return code Description
ERROR_ACCESS_DISABLED_BY_POLICY
コンピューターまたはユーザーのグループポリシーによってこの操作が禁止されています。
ERROR_INTERNAL_ERROR
関数内で予期しないエラーが発生しました。
ERROR_INVALID_PARAMETER
パラメーターの値が無効でした。

解説(Remarks)

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

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

SetUserGeoName は、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 SetUserGeoName(
    LPWSTR geoName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetUserGeoName(
    [MarshalAs(UnmanagedType.LPWStr)] string geoName   // LPWSTR
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetUserGeoName(
    <MarshalAs(UnmanagedType.LPWStr)> geoName As String   ' LPWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' geoName : LPWSTR
Declare PtrSafe Function SetUserGeoName Lib "kernel32" ( _
    ByVal geoName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetUserGeoName = ctypes.windll.kernel32.SetUserGeoName
SetUserGeoName.restype = wintypes.BOOL
SetUserGeoName.argtypes = [
    wintypes.LPCWSTR,  # geoName : LPWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetUserGeoName = Fiddle::Function.new(
  lib['SetUserGeoName'],
  [
    Fiddle::TYPE_VOIDP,  # geoName : LPWSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetUserGeoName(
        geoName: *mut u16  // LPWSTR
    ) -> 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 SetUserGeoName([MarshalAs(UnmanagedType.LPWStr)] string geoName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetUserGeoName' -Namespace Win32 -PassThru
# $api::SetUserGeoName(geoName)
#uselib "KERNEL32.dll"
#func global SetUserGeoName "SetUserGeoName" sptr
; SetUserGeoName geoName   ; 戻り値は stat
; geoName : LPWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetUserGeoName "SetUserGeoName" wstr
; res = SetUserGeoName(geoName)
; geoName : LPWSTR -> "wstr"
; BOOL SetUserGeoName(LPWSTR geoName)
#uselib "KERNEL32.dll"
#cfunc global SetUserGeoName "SetUserGeoName" wstr
; res = SetUserGeoName(geoName)
; geoName : LPWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetUserGeoName = kernel32.NewProc("SetUserGeoName")
)

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

extern "kernel32" fn SetUserGeoName(
    geoName: [*c]const u16 // LPWSTR
) callconv(std.os.windows.WINAPI) i32;
proc SetUserGeoName(
    geoName: WideCString  # LPWSTR
): int32 {.importc: "SetUserGeoName", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetUserGeoName(
    const(wchar)* geoName   // LPWSTR
);
ccall((:SetUserGeoName, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring,),
      geoName)
# geoName : LPWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetUserGeoName(
    const uint16_t* geoName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetUserGeoName(geoName)
-- geoName : LPWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetUserGeoName = lib.func('__stdcall', 'SetUserGeoName', 'int32_t', ['str16']);
// SetUserGeoName(geoName)
// geoName : LPWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetUserGeoName: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.SetUserGeoName(geoName)
// geoName : LPWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetUserGeoName(
    const uint16_t* geoName);
C, "KERNEL32.dll");
// $ffi->SetUserGeoName(geoName);
// geoName : LPWSTR
// 構造体/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 SetUserGeoName(
        WString geoName   // LPWSTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetUserGeoName = SetUserGeoName(
    geoName : UInt16*   # LPWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("SetUserGeoName" set-user-geo-name :convention :stdcall) :int32
  (geo-name (:string :encoding :utf-16le)))   ; LPWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetUserGeoName = Win32::API::More->new('KERNEL32',
    'BOOL SetUserGeoName(LPCWSTR geoName)');
# my $ret = $SetUserGeoName->Call($geoName);
# geoName : LPWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目