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

EnumSystemLocalesW

関数
システムにインストールされたロケールをUnicodeで列挙する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL EnumSystemLocalesW(
    LOCALE_ENUMPROCW lpLocaleEnumProc,
    DWORD dwFlags
);

パラメーター

名前方向説明
lpLocaleEnumProcLOCALE_ENUMPROCWinアプリケーション定義のコールバック関数へのポインター。詳細については EnumLocalesProc を参照してください。
dwFlagsDWORDin

列挙するロケール識別子を指定するフラグです。フラグは単独で使用することも、バイナリ OR で組み合わせて使用することもできます。このパラメーターに 0 を指定した場合、関数は LCID_SUPPORTED を指定した場合と同様に動作します。

Value Meaning
LCID_INSTALLED
インストールされているロケール識別子のみを列挙します。この値は LCID_SUPPORTED と併用できません。
LCID_SUPPORTED
サポートされているすべてのロケール識別子を列挙します。この値は LCID_INSTALLED と併用できません。
LCID_ALTERNATE_SORTS
代替ソート用のロケール識別子のみを列挙します。この値を LCID_INSTALLED または LCID_SUPPORTED と併用した場合、インストール済みまたはサポート対象のロケールに加えて、代替ソート用のロケール識別子も取得されます。

戻り値の型: BOOL

公式ドキュメント

オペレーティングシステムにインストールされている、またはサポートされているロケールを列挙します。注意 相互運用性の理由から、アプリケーションは EnumSystemLocales よりも EnumSystemLocalesEx 関数を使用することが推奨されます。これは、Microsoft が新しいロケールについてロケール識別子ではなくロケール名の使用へ移行しているためです。Windows Vista 以降でのみ実行されるアプリケーションは EnumSystemLocalesEx を使用してください。(Unicode)

戻り値

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

解説(Remarks)

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

メモ

winnls.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして EnumSystemLocales を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については 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 EnumSystemLocalesW(
    LOCALE_ENUMPROCW lpLocaleEnumProc,
    DWORD dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool EnumSystemLocalesW(
    IntPtr lpLocaleEnumProc,   // LOCALE_ENUMPROCW
    uint dwFlags   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumSystemLocalesW(
    lpLocaleEnumProc As IntPtr,   ' LOCALE_ENUMPROCW
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpLocaleEnumProc : LOCALE_ENUMPROCW
' dwFlags : DWORD
Declare PtrSafe Function EnumSystemLocalesW Lib "kernel32" ( _
    ByVal lpLocaleEnumProc As LongPtr, _
    ByVal dwFlags As Long) 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

EnumSystemLocalesW = ctypes.windll.kernel32.EnumSystemLocalesW
EnumSystemLocalesW.restype = wintypes.BOOL
EnumSystemLocalesW.argtypes = [
    ctypes.c_void_p,  # lpLocaleEnumProc : LOCALE_ENUMPROCW
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
EnumSystemLocalesW = Fiddle::Function.new(
  lib['EnumSystemLocalesW'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleEnumProc : LOCALE_ENUMPROCW
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn EnumSystemLocalesW(
        lpLocaleEnumProc: *const core::ffi::c_void,  // LOCALE_ENUMPROCW
        dwFlags: u32  // DWORD
    ) -> 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 EnumSystemLocalesW(IntPtr lpLocaleEnumProc, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_EnumSystemLocalesW' -Namespace Win32 -PassThru
# $api::EnumSystemLocalesW(lpLocaleEnumProc, dwFlags)
#uselib "KERNEL32.dll"
#func global EnumSystemLocalesW "EnumSystemLocalesW" wptr, wptr
; EnumSystemLocalesW lpLocaleEnumProc, dwFlags   ; 戻り値は stat
; lpLocaleEnumProc : LOCALE_ENUMPROCW -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global EnumSystemLocalesW "EnumSystemLocalesW" sptr, int
; res = EnumSystemLocalesW(lpLocaleEnumProc, dwFlags)
; lpLocaleEnumProc : LOCALE_ENUMPROCW -> "sptr"
; dwFlags : DWORD -> "int"
; BOOL EnumSystemLocalesW(LOCALE_ENUMPROCW lpLocaleEnumProc, DWORD dwFlags)
#uselib "KERNEL32.dll"
#cfunc global EnumSystemLocalesW "EnumSystemLocalesW" intptr, int
; res = EnumSystemLocalesW(lpLocaleEnumProc, dwFlags)
; lpLocaleEnumProc : LOCALE_ENUMPROCW -> "intptr"
; dwFlags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEnumSystemLocalesW = kernel32.NewProc("EnumSystemLocalesW")
)

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

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

typedef EnumSystemLocalesWNative = Int32 Function(Pointer<Void>, Uint32);
typedef EnumSystemLocalesWDart = int Function(Pointer<Void>, int);
final EnumSystemLocalesW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<EnumSystemLocalesWNative, EnumSystemLocalesWDart>('EnumSystemLocalesW');
// lpLocaleEnumProc : LOCALE_ENUMPROCW -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumSystemLocalesW(
  lpLocaleEnumProc: Pointer;   // LOCALE_ENUMPROCW
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumSystemLocalesW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnumSystemLocalesW"
  c_EnumSystemLocalesW :: Ptr () -> Word32 -> IO CInt
-- lpLocaleEnumProc : LOCALE_ENUMPROCW -> Ptr ()
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let enumsystemlocalesw =
  foreign "EnumSystemLocalesW"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* lpLocaleEnumProc : LOCALE_ENUMPROCW -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("EnumSystemLocalesW" enum-system-locales-w :convention :stdcall) :int32
  (lp-locale-enum-proc :pointer)   ; LOCALE_ENUMPROCW
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumSystemLocalesW = Win32::API::More->new('KERNEL32',
    'BOOL EnumSystemLocalesW(LPVOID lpLocaleEnumProc, DWORD dwFlags)');
# my $ret = $EnumSystemLocalesW->Call($lpLocaleEnumProc, $dwFlags);
# lpLocaleEnumProc : LOCALE_ENUMPROCW -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
使用する型