SetLocaleInfoA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL SetLocaleInfoA(
DWORD Locale,
DWORD LCType,
LPCSTR lpLCData
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Locale | DWORD | in | この関数の ANSI 版では、lpLCData 情報を解釈する際に使用するコードページを持つロケールのロケール識別子です。Unicode 版では、このパラメーターは無視されます。 MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 次のカスタムロケール識別子もサポートされています。 |
| LCType | DWORD | in | 設定するロケール情報の種類です。有効な定数については、Locale Information Constants の「Constants Used in the LCType Parameter of GetLocaleInfo, GetLocaleInfoEx, and SetLocaleInfo」セクションを参照してください。アプリケーションは 1 回の呼び出しにつき 1 つの値のみを指定できますが、バイナリ OR 演算子を使用して LOCALE_USE_CP_ACP を他の任意の定数と組み合わせることができます。 |
| lpLCData | LPCSTR | in | 設定するロケール情報を含む、null 終端文字列へのポインターです。情報は、指定された定数に固有の形式である必要があります。アプリケーションは、この関数の Unicode 版では Unicode 文字列を、ANSI 版では ANSI 文字列を使用します。 |
戻り値の型: BOOL
公式ドキュメント
現在のロケールのユーザーオーバーライド部分に情報項目を設定します。この関数はシステムの既定値を設定しません。(ANSI)
戻り値
成功した場合は 0 以外の値を返し、それ以外の場合は 0 を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができます。この関数は次のいずれかのエラーコードを返すことがあります。
- ERROR_ACCESS_DISABLED_BY_POLICY。コンピューターまたはユーザーのグループポリシーがこの操作を禁止しています。
- ERROR_INVALID_ACCESS。アクセスコードが無効でした。
- ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
- ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。
解説(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 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL SetLocaleInfoA(
DWORD Locale,
DWORD LCType,
LPCSTR lpLCData
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetLocaleInfoA(
uint Locale, // DWORD
uint LCType, // DWORD
[MarshalAs(UnmanagedType.LPStr)] string lpLCData // LPCSTR
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetLocaleInfoA(
Locale As UInteger, ' DWORD
LCType As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPStr)> lpLCData As String ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' Locale : DWORD
' LCType : DWORD
' lpLCData : LPCSTR
Declare PtrSafe Function SetLocaleInfoA Lib "kernel32" ( _
ByVal Locale As Long, _
ByVal LCType As Long, _
ByVal lpLCData As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetLocaleInfoA = ctypes.windll.kernel32.SetLocaleInfoA
SetLocaleInfoA.restype = wintypes.BOOL
SetLocaleInfoA.argtypes = [
wintypes.DWORD, # Locale : DWORD
wintypes.DWORD, # LCType : DWORD
wintypes.LPCSTR, # lpLCData : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
SetLocaleInfoA = Fiddle::Function.new(
lib['SetLocaleInfoA'],
[
-Fiddle::TYPE_INT, # Locale : DWORD
-Fiddle::TYPE_INT, # LCType : DWORD
Fiddle::TYPE_VOIDP, # lpLCData : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn SetLocaleInfoA(
Locale: u32, // DWORD
LCType: u32, // DWORD
lpLCData: *const u8 // LPCSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SetLocaleInfoA(uint Locale, uint LCType, [MarshalAs(UnmanagedType.LPStr)] string lpLCData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetLocaleInfoA' -Namespace Win32 -PassThru
# $api::SetLocaleInfoA(Locale, LCType, lpLCData)#uselib "KERNEL32.dll"
#func global SetLocaleInfoA "SetLocaleInfoA" sptr, sptr, sptr
; SetLocaleInfoA Locale, LCType, lpLCData ; 戻り値は stat
; Locale : DWORD -> "sptr"
; LCType : DWORD -> "sptr"
; lpLCData : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global SetLocaleInfoA "SetLocaleInfoA" int, int, str
; res = SetLocaleInfoA(Locale, LCType, lpLCData)
; Locale : DWORD -> "int"
; LCType : DWORD -> "int"
; lpLCData : LPCSTR -> "str"; BOOL SetLocaleInfoA(DWORD Locale, DWORD LCType, LPCSTR lpLCData)
#uselib "KERNEL32.dll"
#cfunc global SetLocaleInfoA "SetLocaleInfoA" int, int, str
; res = SetLocaleInfoA(Locale, LCType, lpLCData)
; Locale : DWORD -> "int"
; LCType : DWORD -> "int"
; lpLCData : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSetLocaleInfoA = kernel32.NewProc("SetLocaleInfoA")
)
// Locale (DWORD), LCType (DWORD), lpLCData (LPCSTR)
r1, _, err := procSetLocaleInfoA.Call(
uintptr(Locale),
uintptr(LCType),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpLCData))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetLocaleInfoA(
Locale: DWORD; // DWORD
LCType: DWORD; // DWORD
lpLCData: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetLocaleInfoA';result := DllCall("KERNEL32\SetLocaleInfoA"
, "UInt", Locale ; DWORD
, "UInt", LCType ; DWORD
, "AStr", lpLCData ; LPCSTR
, "Int") ; return: BOOL●SetLocaleInfoA(Locale, LCType, lpLCData) = DLL("KERNEL32.dll", "bool SetLocaleInfoA(dword, dword, char*)")
# 呼び出し: SetLocaleInfoA(Locale, LCType, lpLCData)
# Locale : DWORD -> "dword"
# LCType : DWORD -> "dword"
# lpLCData : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn SetLocaleInfoA(
Locale: u32, // DWORD
LCType: u32, // DWORD
lpLCData: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc SetLocaleInfoA(
Locale: uint32, # DWORD
LCType: uint32, # DWORD
lpLCData: cstring # LPCSTR
): int32 {.importc: "SetLocaleInfoA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int SetLocaleInfoA(
uint Locale, // DWORD
uint LCType, // DWORD
const(char)* lpLCData // LPCSTR
);ccall((:SetLocaleInfoA, "KERNEL32.dll"), stdcall, Int32,
(UInt32, UInt32, Cstring),
Locale, LCType, lpLCData)
# Locale : DWORD -> UInt32
# LCType : DWORD -> UInt32
# lpLCData : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SetLocaleInfoA(
uint32_t Locale,
uint32_t LCType,
const char* lpLCData);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetLocaleInfoA(Locale, LCType, lpLCData)
-- Locale : DWORD
-- LCType : DWORD
-- lpLCData : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetLocaleInfoA = lib.func('__stdcall', 'SetLocaleInfoA', 'int32_t', ['uint32_t', 'uint32_t', 'str']);
// SetLocaleInfoA(Locale, LCType, lpLCData)
// Locale : DWORD -> 'uint32_t'
// LCType : DWORD -> 'uint32_t'
// lpLCData : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SetLocaleInfoA: { parameters: ["u32", "u32", "buffer"], result: "i32" },
});
// lib.symbols.SetLocaleInfoA(Locale, LCType, lpLCData)
// Locale : DWORD -> "u32"
// LCType : DWORD -> "u32"
// lpLCData : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetLocaleInfoA(
uint32_t Locale,
uint32_t LCType,
const char* lpLCData);
C, "KERNEL32.dll");
// $ffi->SetLocaleInfoA(Locale, LCType, lpLCData);
// Locale : DWORD
// LCType : DWORD
// lpLCData : LPCSTR
// 構造体/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.ASCII_OPTIONS);
boolean SetLocaleInfoA(
int Locale, // DWORD
int LCType, // DWORD
String lpLCData // LPCSTR
);
}@[Link("kernel32")]
lib LibKERNEL32
fun SetLocaleInfoA = SetLocaleInfoA(
Locale : UInt32, # DWORD
LCType : UInt32, # DWORD
lpLCData : UInt8* # LPCSTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetLocaleInfoANative = Int32 Function(Uint32, Uint32, Pointer<Utf8>);
typedef SetLocaleInfoADart = int Function(int, int, Pointer<Utf8>);
final SetLocaleInfoA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SetLocaleInfoANative, SetLocaleInfoADart>('SetLocaleInfoA');
// Locale : DWORD -> Uint32
// LCType : DWORD -> Uint32
// lpLCData : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetLocaleInfoA(
Locale: DWORD; // DWORD
LCType: DWORD; // DWORD
lpLCData: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetLocaleInfoA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetLocaleInfoA"
c_SetLocaleInfoA :: Word32 -> Word32 -> CString -> IO CInt
-- Locale : DWORD -> Word32
-- LCType : DWORD -> Word32
-- lpLCData : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setlocaleinfoa =
foreign "SetLocaleInfoA"
(uint32_t @-> uint32_t @-> string @-> returning int32_t)
(* Locale : DWORD -> uint32_t *)
(* LCType : DWORD -> uint32_t *)
(* lpLCData : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("SetLocaleInfoA" set-locale-info-a :convention :stdcall) :int32
(locale :uint32) ; DWORD
(lctype :uint32) ; DWORD
(lp-lcdata :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetLocaleInfoA = Win32::API::More->new('KERNEL32',
'BOOL SetLocaleInfoA(DWORD Locale, DWORD LCType, LPCSTR lpLCData)');
# my $ret = $SetLocaleInfoA->Call($Locale, $LCType, $lpLCData);
# Locale : DWORD -> DWORD
# LCType : DWORD -> DWORD
# lpLCData : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f SetLocaleInfoW (Unicode版) — ユーザーロケールの項目を設定する。Unicode版。
- f GetLocaleInfoA — 指定ロケールの各種情報を取得する。ANSI版。