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

SetLocaleInfoW

関数
ユーザーロケールの項目を設定する。Unicode版。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetLocaleInfoW(
    DWORD Locale,
    DWORD LCType,
    LPCWSTR lpLCData
);

パラメーター

名前方向説明
LocaleDWORDin

この関数の ANSI 版では、lpLCData の情報を解釈する際に使用するコード ページを持つロケールの ロケール識別子です。Unicode 版では、このパラメーターは無視されます。

MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。

次のカスタム ロケール識別子もサポートされています。
LCTypeDWORDin設定するロケール情報の種類です。有効な定数については、Locale Information Constants の「Constants Used in the LCType Parameter of GetLocaleInfo, GetLocaleInfoEx, and SetLocaleInfo」セクションを参照してください。アプリケーションは 1 回の呼び出しにつき 1 つの値しか指定できませんが、バイナリ OR 演算子を使用して LOCALE_USE_CP_ACP を他の任意の定数と組み合わせることができます。
lpLCDataLPCWSTRin設定するロケール情報を格納した、null で終わる文字列へのポインターです。情報は指定した定数に固有の形式である必要があります。アプリケーションは、この関数の Unicode 版では Unicode 文字列を、ANSI 版では ANSI 文字列を使用します。

戻り値の型: BOOL

公式ドキュメント

現在のロケールのユーザー オーバーライド部分に情報項目を設定します。この関数はシステムの既定値は設定しません。(Unicode)

戻り値

成功した場合は 0 以外の値を、それ以外の場合は 0 を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができます。この関数は次のいずれかのエラー コードを返すことがあります。

解説(Remarks)

この関数はレジストリに書き込み、特定のアプリケーションではなく特定のユーザーに関連付けられた値を設定します。これらのレジストリ値は、そのユーザーが実行する他のアプリケーションの動作に影響します。原則として、アプリケーションはユーザーが明示的に変更を要求した場合にのみこの関数を呼び出すべきです。単一のアプリケーションの都合でレジストリ設定を変更すべきではありません。

LCType パラメーターについては、文字列変換にロケールのコード ページではなくオペレーティング システムの ANSI コード ページを使用するために、アプリケーションは LOCALE_USE_CP_ACP を設定する必要があります。

この関数の ANSI 版を Unicode 専用のロケール識別子と共に使用した場合、オペレーティング システムがシステム コード ページを使用するため、関数は成功することがあります。ただし、システム コード ページで未定義の文字は、文字列内で疑問符 (?) として表示されます。

Windows Vista 以降、LOCALE_SDATE および LOCALE_STIME 定数は廃止されました。これらの定数は使用しないでください。代わりに LOCALE_SSHORTDATE および LOCALE_STIMEFORMAT を使用してください。カスタム ロケールでは、日付または時刻の形式内に単一の統一された区切り文字が存在しない場合があります。たとえば、"12/31, 2006" や "03:56'23" のような形式が有効な場合があります。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL SetLocaleInfoW(
    DWORD Locale,
    DWORD LCType,
    LPCWSTR lpLCData
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetLocaleInfoW(
    uint Locale,   // DWORD
    uint LCType,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpLCData   // LPCWSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetLocaleInfoW(
    Locale As UInteger,   ' DWORD
    LCType As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpLCData As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Locale : DWORD
' LCType : DWORD
' lpLCData : LPCWSTR
Declare PtrSafe Function SetLocaleInfoW Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal LCType As Long, _
    ByVal lpLCData As LongPtr) 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

SetLocaleInfoW = ctypes.windll.kernel32.SetLocaleInfoW
SetLocaleInfoW.restype = wintypes.BOOL
SetLocaleInfoW.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # LCType : DWORD
    wintypes.LPCWSTR,  # lpLCData : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetLocaleInfoW = Fiddle::Function.new(
  lib['SetLocaleInfoW'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # LCType : DWORD
    Fiddle::TYPE_VOIDP,  # lpLCData : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn SetLocaleInfoW(
        Locale: u32,  // DWORD
        LCType: u32,  // DWORD
        lpLCData: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetLocaleInfoW(uint Locale, uint LCType, [MarshalAs(UnmanagedType.LPWStr)] string lpLCData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetLocaleInfoW' -Namespace Win32 -PassThru
# $api::SetLocaleInfoW(Locale, LCType, lpLCData)
#uselib "KERNEL32.dll"
#func global SetLocaleInfoW "SetLocaleInfoW" wptr, wptr, wptr
; SetLocaleInfoW Locale, LCType, lpLCData   ; 戻り値は stat
; Locale : DWORD -> "wptr"
; LCType : DWORD -> "wptr"
; lpLCData : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetLocaleInfoW "SetLocaleInfoW" int, int, wstr
; res = SetLocaleInfoW(Locale, LCType, lpLCData)
; Locale : DWORD -> "int"
; LCType : DWORD -> "int"
; lpLCData : LPCWSTR -> "wstr"
; BOOL SetLocaleInfoW(DWORD Locale, DWORD LCType, LPCWSTR lpLCData)
#uselib "KERNEL32.dll"
#cfunc global SetLocaleInfoW "SetLocaleInfoW" int, int, wstr
; res = SetLocaleInfoW(Locale, LCType, lpLCData)
; Locale : DWORD -> "int"
; LCType : DWORD -> "int"
; lpLCData : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetLocaleInfoW = kernel32.NewProc("SetLocaleInfoW")
)

// Locale (DWORD), LCType (DWORD), lpLCData (LPCWSTR)
r1, _, err := procSetLocaleInfoW.Call(
	uintptr(Locale),
	uintptr(LCType),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpLCData))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetLocaleInfoW(
  Locale: DWORD;   // DWORD
  LCType: DWORD;   // DWORD
  lpLCData: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetLocaleInfoW';
result := DllCall("KERNEL32\SetLocaleInfoW"
    , "UInt", Locale   ; DWORD
    , "UInt", LCType   ; DWORD
    , "WStr", lpLCData   ; LPCWSTR
    , "Int")   ; return: BOOL
●SetLocaleInfoW(Locale, LCType, lpLCData) = DLL("KERNEL32.dll", "bool SetLocaleInfoW(dword, dword, char*)")
# 呼び出し: SetLocaleInfoW(Locale, LCType, lpLCData)
# Locale : DWORD -> "dword"
# LCType : DWORD -> "dword"
# lpLCData : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn SetLocaleInfoW(
    Locale: u32, // DWORD
    LCType: u32, // DWORD
    lpLCData: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetLocaleInfoW(
    Locale: uint32,  # DWORD
    LCType: uint32,  # DWORD
    lpLCData: WideCString  # LPCWSTR
): int32 {.importc: "SetLocaleInfoW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int SetLocaleInfoW(
    uint Locale,   // DWORD
    uint LCType,   // DWORD
    const(wchar)* lpLCData   // LPCWSTR
);
ccall((:SetLocaleInfoW, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, UInt32, Cwstring),
      Locale, LCType, lpLCData)
# Locale : DWORD -> UInt32
# LCType : DWORD -> UInt32
# lpLCData : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetLocaleInfoW(
    uint32_t Locale,
    uint32_t LCType,
    const uint16_t* lpLCData);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetLocaleInfoW(Locale, LCType, lpLCData)
-- Locale : DWORD
-- LCType : DWORD
-- lpLCData : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetLocaleInfoW = lib.func('__stdcall', 'SetLocaleInfoW', 'int32_t', ['uint32_t', 'uint32_t', 'str16']);
// SetLocaleInfoW(Locale, LCType, lpLCData)
// Locale : DWORD -> 'uint32_t'
// LCType : DWORD -> 'uint32_t'
// lpLCData : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetLocaleInfoW: { parameters: ["u32", "u32", "buffer"], result: "i32" },
});
// lib.symbols.SetLocaleInfoW(Locale, LCType, lpLCData)
// Locale : DWORD -> "u32"
// LCType : DWORD -> "u32"
// lpLCData : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetLocaleInfoW(
    uint32_t Locale,
    uint32_t LCType,
    const uint16_t* lpLCData);
C, "KERNEL32.dll");
// $ffi->SetLocaleInfoW(Locale, LCType, lpLCData);
// Locale : DWORD
// LCType : DWORD
// lpLCData : LPCWSTR
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    boolean SetLocaleInfoW(
        int Locale,   // DWORD
        int LCType,   // DWORD
        WString lpLCData   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun SetLocaleInfoW = SetLocaleInfoW(
    Locale : UInt32,   # DWORD
    LCType : UInt32,   # DWORD
    lpLCData : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

foreign import stdcall safe "SetLocaleInfoW"
  c_SetLocaleInfoW :: Word32 -> Word32 -> CWString -> IO CInt
-- Locale : DWORD -> Word32
-- LCType : DWORD -> Word32
-- lpLCData : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setlocaleinfow =
  foreign "SetLocaleInfoW"
    (uint32_t @-> uint32_t @-> (ptr uint16_t) @-> returning int32_t)
(* Locale : DWORD -> uint32_t *)
(* LCType : DWORD -> uint32_t *)
(* lpLCData : LPCWSTR -> (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 ("SetLocaleInfoW" set-locale-info-w :convention :stdcall) :int32
  (locale :uint32)   ; DWORD
  (lctype :uint32)   ; DWORD
  (lp-lcdata (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetLocaleInfoW = Win32::API::More->new('KERNEL32',
    'BOOL SetLocaleInfoW(DWORD Locale, DWORD LCType, LPCWSTR lpLCData)');
# my $ret = $SetLocaleInfoW->Call($Locale, $LCType, $lpLCData);
# Locale : DWORD -> DWORD
# LCType : DWORD -> DWORD
# lpLCData : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目