ホーム › Globalization › EnumSystemLocalesEx

EnumSystemLocalesEx

関数

システムのロケールを拡張コールバックで列挙する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL EnumSystemLocalesEx(
    LOCALE_ENUMPROCEX lpLocaleEnumProcEx,
    DWORD dwFlags,
    LPARAM lParam,
    void* lpReserved   // optional
);

パラメーター

名前	型	方向	説明
lpLocaleEnumProcEx	LOCALE_ENUMPROCEX	in	アプリケーション定義のコールバック関数へのポインターです。EnumSystemLocalesEx 関数は、このコールバック関数を繰り返し呼び出すことでロケールを列挙します。詳細については、EnumLocalesProcEx を参照してください。
dwFlags	DWORD	in	列挙するロケールを識別するフラグです。フラグは単独で使用することも、バイナリ OR で組み合わせて使用することもできます。このパラメーターに 0 を指定した場合、関数は LOCALE_ALL を指定した場合と同様に動作します。 LOCALE_ALL LOCALE_ALTERNATE_SORTS; 「解説」を参照 LOCALE_NEUTRALDATA LOCALE_SUPPLEMENTAL LOCALE_WINDOWS LOCALE_SPECIFICDATA
lParam	LPARAM	in	コールバック関数に渡される、アプリケーションが指定するパラメーターです。これはマルチスレッドアプリケーションで特に役立ちます。
lpReserved	void*	inoptional	予約済みです。NULL を指定してください。

戻り値の型: BOOL

公式ドキュメント

オペレーティングシステムにインストールされている、またはサポートされているロケールを列挙します。Note Windows Vista 以降でのみ動作するように設計されたアプリケーションでは、EnumSystemLocales よりもこの関数を優先して呼び出してください。

戻り値

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

ERROR_BADDB. 関数はデータにアクセスできませんでした。この状況は通常発生せず、一般的にはインストールの不具合、ディスクの問題などを示します。
ERROR_INVALID_FLAGS. フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER. いずれかのパラメーター値が無効でした。

解説(Remarks)

この関数は、ロケール名を 1 つずつ lpLocaleEnumProcEx で指定されたアプリケーション定義のコールバック関数に渡すことでロケールを列挙します。列挙は、インストールまたはサポートされているすべての名前がコールバック関数に渡されるか、コールバック関数が FALSE を返すまで続行されます。

dwFlags パラメーターの選択肢は、インストールされているロケールとサポートされているロケールを区別する必要がある EnumSystemLocales の選択肢とは異なります。

dwFlags に LOCALE_ALTERNATE_SORTS を指定した場合、代替の並べ替え順序を表すすべてのロケールに対してコールバック関数が呼び出されます。たとえば、スペイン語 (スペイン) は既定で国際的な並べ替え順序を使用しますが、代替の並べ替えとして従来の並べ替え順序が利用できます。ドイツ語 (ドイツ) は既定で辞書順の並べ替え順序を使用しますが、代替として電話帳順の並べ替え順序が利用できます。

Examples

この関数の使用例は、NLS: Name-based APIs Sample に記載されています。

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

各言語での呼び出し定義

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

BOOL EnumSystemLocalesEx(
    LOCALE_ENUMPROCEX lpLocaleEnumProcEx,
    DWORD dwFlags,
    LPARAM lParam,
    void* lpReserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EnumSystemLocalesEx(
    IntPtr lpLocaleEnumProcEx,   // LOCALE_ENUMPROCEX
    uint dwFlags,   // DWORD
    IntPtr lParam,   // LPARAM
    IntPtr lpReserved   // void* optional
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumSystemLocalesEx(
    lpLocaleEnumProcEx As IntPtr,   ' LOCALE_ENUMPROCEX
    dwFlags As UInteger,   ' DWORD
    lParam As IntPtr,   ' LPARAM
    lpReserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpLocaleEnumProcEx : LOCALE_ENUMPROCEX
' dwFlags : DWORD
' lParam : LPARAM
' lpReserved : void* optional
Declare PtrSafe Function EnumSystemLocalesEx Lib "kernel32" ( _
    ByVal lpLocaleEnumProcEx As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lParam As LongPtr, _
    ByVal lpReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EnumSystemLocalesEx = ctypes.windll.kernel32.EnumSystemLocalesEx
EnumSystemLocalesEx.restype = wintypes.BOOL
EnumSystemLocalesEx.argtypes = [
    ctypes.c_void_p,  # lpLocaleEnumProcEx : LOCALE_ENUMPROCEX
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_ssize_t,  # lParam : LPARAM
    ctypes.POINTER(None),  # lpReserved : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
EnumSystemLocalesEx = Fiddle::Function.new(
  lib['EnumSystemLocalesEx'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleEnumProcEx : LOCALE_ENUMPROCEX
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn EnumSystemLocalesEx(
        lpLocaleEnumProcEx: *const core::ffi::c_void,  // LOCALE_ENUMPROCEX
        dwFlags: u32,  // DWORD
        lParam: isize,  // LPARAM
        lpReserved: *mut ()  // void* optional
    ) -> 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 EnumSystemLocalesEx(IntPtr lpLocaleEnumProcEx, uint dwFlags, IntPtr lParam, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_EnumSystemLocalesEx' -Namespace Win32 -PassThru
# $api::EnumSystemLocalesEx(lpLocaleEnumProcEx, dwFlags, lParam, lpReserved)

#uselib "KERNEL32.dll"
#func global EnumSystemLocalesEx "EnumSystemLocalesEx" sptr, sptr, sptr, sptr
; EnumSystemLocalesEx lpLocaleEnumProcEx, dwFlags, lParam, lpReserved   ; 戻り値は stat
; lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> "sptr"
; dwFlags : DWORD -> "sptr"
; lParam : LPARAM -> "sptr"
; lpReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global EnumSystemLocalesEx "EnumSystemLocalesEx" sptr, int, sptr, sptr
; res = EnumSystemLocalesEx(lpLocaleEnumProcEx, dwFlags, lParam, lpReserved)
; lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> "sptr"
; dwFlags : DWORD -> "int"
; lParam : LPARAM -> "sptr"
; lpReserved : void* optional -> "sptr"

; BOOL EnumSystemLocalesEx(LOCALE_ENUMPROCEX lpLocaleEnumProcEx, DWORD dwFlags, LPARAM lParam, void* lpReserved)
#uselib "KERNEL32.dll"
#cfunc global EnumSystemLocalesEx "EnumSystemLocalesEx" intptr, int, intptr, intptr
; res = EnumSystemLocalesEx(lpLocaleEnumProcEx, dwFlags, lParam, lpReserved)
; lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> "intptr"
; dwFlags : DWORD -> "int"
; lParam : LPARAM -> "intptr"
; lpReserved : void* optional -> "intptr"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEnumSystemLocalesEx = kernel32.NewProc("EnumSystemLocalesEx")
)

// lpLocaleEnumProcEx (LOCALE_ENUMPROCEX), dwFlags (DWORD), lParam (LPARAM), lpReserved (void* optional)
r1, _, err := procEnumSystemLocalesEx.Call(
	uintptr(lpLocaleEnumProcEx),
	uintptr(dwFlags),
	uintptr(lParam),
	uintptr(lpReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function EnumSystemLocalesEx(
  lpLocaleEnumProcEx: Pointer;   // LOCALE_ENUMPROCEX
  dwFlags: DWORD;   // DWORD
  lParam: NativeInt;   // LPARAM
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumSystemLocalesEx';

result := DllCall("KERNEL32\EnumSystemLocalesEx"
    , "Ptr", lpLocaleEnumProcEx   ; LOCALE_ENUMPROCEX
    , "UInt", dwFlags   ; DWORD
    , "Ptr", lParam   ; LPARAM
    , "Ptr", lpReserved   ; void* optional
    , "Int")   ; return: BOOL

●EnumSystemLocalesEx(lpLocaleEnumProcEx, dwFlags, lParam, lpReserved) = DLL("KERNEL32.dll", "bool EnumSystemLocalesEx(void*, dword, int, void*)")
# 呼び出し: EnumSystemLocalesEx(lpLocaleEnumProcEx, dwFlags, lParam, lpReserved)
# lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> "void*"
# dwFlags : DWORD -> "dword"
# lParam : LPARAM -> "int"
# lpReserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "kernel32" fn EnumSystemLocalesEx(
    lpLocaleEnumProcEx: ?*anyopaque, // LOCALE_ENUMPROCEX
    dwFlags: u32, // DWORD
    lParam: isize, // LPARAM
    lpReserved: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;

proc EnumSystemLocalesEx(
    lpLocaleEnumProcEx: pointer,  # LOCALE_ENUMPROCEX
    dwFlags: uint32,  # DWORD
    lParam: int,  # LPARAM
    lpReserved: pointer  # void* optional
): int32 {.importc: "EnumSystemLocalesEx", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int EnumSystemLocalesEx(
    void* lpLocaleEnumProcEx,   // LOCALE_ENUMPROCEX
    uint dwFlags,   // DWORD
    ptrdiff_t lParam,   // LPARAM
    void* lpReserved   // void* optional
);

ccall((:EnumSystemLocalesEx, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Int, Ptr{Cvoid}),
      lpLocaleEnumProcEx, dwFlags, lParam, lpReserved)
# lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# lParam : LPARAM -> Int
# lpReserved : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t EnumSystemLocalesEx(
    void* lpLocaleEnumProcEx,
    uint32_t dwFlags,
    intptr_t lParam,
    void* lpReserved);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.EnumSystemLocalesEx(lpLocaleEnumProcEx, dwFlags, lParam, lpReserved)
-- lpLocaleEnumProcEx : LOCALE_ENUMPROCEX
-- dwFlags : DWORD
-- lParam : LPARAM
-- lpReserved : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const EnumSystemLocalesEx = lib.func('__stdcall', 'EnumSystemLocalesEx', 'int32_t', ['void *', 'uint32_t', 'intptr_t', 'void *']);
// EnumSystemLocalesEx(lpLocaleEnumProcEx, dwFlags, lParam, lpReserved)
// lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// lParam : LPARAM -> 'intptr_t'
// lpReserved : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。

const lib = Deno.dlopen("KERNEL32.dll", {
  EnumSystemLocalesEx: { parameters: ["pointer", "u32", "isize", "pointer"], result: "i32" },
});
// lib.symbols.EnumSystemLocalesEx(lpLocaleEnumProcEx, dwFlags, lParam, lpReserved)
// lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> "pointer"
// dwFlags : DWORD -> "u32"
// lParam : LPARAM -> "isize"
// lpReserved : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t EnumSystemLocalesEx(
    void* lpLocaleEnumProcEx,
    uint32_t dwFlags,
    intptr_t lParam,
    void* lpReserved);
C, "KERNEL32.dll");
// $ffi->EnumSystemLocalesEx(lpLocaleEnumProcEx, dwFlags, lParam, lpReserved);
// lpLocaleEnumProcEx : LOCALE_ENUMPROCEX
// dwFlags : DWORD
// lParam : LPARAM
// lpReserved : void* optional
// 構造体/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 EnumSystemLocalesEx(
        Callback lpLocaleEnumProcEx,   // LOCALE_ENUMPROCEX
        int dwFlags,   // DWORD
        long lParam,   // LPARAM
        Pointer lpReserved   // void* optional
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun EnumSystemLocalesEx = EnumSystemLocalesEx(
    lpLocaleEnumProcEx : Void*,   # LOCALE_ENUMPROCEX
    dwFlags : UInt32,   # DWORD
    lParam : LibC::SSizeT,   # LPARAM
    lpReserved : Void*   # void* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EnumSystemLocalesExNative = Int32 Function(Pointer<Void>, Uint32, IntPtr, Pointer<Void>);
typedef EnumSystemLocalesExDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final EnumSystemLocalesEx = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<EnumSystemLocalesExNative, EnumSystemLocalesExDart>('EnumSystemLocalesEx');
// lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// lParam : LPARAM -> IntPtr
// lpReserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function EnumSystemLocalesEx(
  lpLocaleEnumProcEx: Pointer;   // LOCALE_ENUMPROCEX
  dwFlags: DWORD;   // DWORD
  lParam: NativeInt;   // LPARAM
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumSystemLocalesEx';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnumSystemLocalesEx"
  c_EnumSystemLocalesEx :: Ptr () -> Word32 -> CIntPtr -> Ptr () -> IO CInt
-- lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> Ptr ()
-- dwFlags : DWORD -> Word32
-- lParam : LPARAM -> CIntPtr
-- lpReserved : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let enumsystemlocalesex =
  foreign "EnumSystemLocalesEx"
    ((ptr void) @-> uint32_t @-> intptr_t @-> (ptr void) @-> returning int32_t)
(* lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* lParam : LPARAM -> intptr_t *)
(* lpReserved : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("EnumSystemLocalesEx" enum-system-locales-ex :convention :stdcall) :int32
  (lp-locale-enum-proc-ex :pointer)   ; LOCALE_ENUMPROCEX
  (dw-flags :uint32)   ; DWORD
  (l-param :int64)   ; LPARAM
  (lp-reserved :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $EnumSystemLocalesEx = Win32::API::More->new('KERNEL32',
    'BOOL EnumSystemLocalesEx(LPVOID lpLocaleEnumProcEx, DWORD dwFlags, LPARAM lParam, LPVOID lpReserved)');
# my $ret = $EnumSystemLocalesEx->Call($lpLocaleEnumProcEx, $dwFlags, $lParam, $lpReserved);
# lpLocaleEnumProcEx : LOCALE_ENUMPROCEX -> LPVOID
# dwFlags : DWORD -> DWORD
# lParam : LPARAM -> LPARAM
# lpReserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。