ホーム › Globalization › EnumSystemLocalesA

EnumSystemLocalesA

関数

システムにインストールされたロケールをANSIで列挙する。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL EnumSystemLocalesA(
    LOCALE_ENUMPROCA lpLocaleEnumProc,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

lpLocaleEnumProc

LOCALE_ENUMPROCA

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

dwFlags

DWORD

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

メモ

winnls.h ヘッダーは EnumSystemLocales を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL EnumSystemLocalesA(
    LOCALE_ENUMPROCA lpLocaleEnumProc,
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool EnumSystemLocalesA(
    IntPtr lpLocaleEnumProc,   // LOCALE_ENUMPROCA
    uint dwFlags   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumSystemLocalesA(
    lpLocaleEnumProc As IntPtr,   ' LOCALE_ENUMPROCA
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpLocaleEnumProc : LOCALE_ENUMPROCA
' dwFlags : DWORD
Declare PtrSafe Function EnumSystemLocalesA Lib "kernel32" ( _
    ByVal lpLocaleEnumProc As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EnumSystemLocalesA = ctypes.windll.kernel32.EnumSystemLocalesA
EnumSystemLocalesA.restype = wintypes.BOOL
EnumSystemLocalesA.argtypes = [
    ctypes.c_void_p,  # lpLocaleEnumProc : LOCALE_ENUMPROCA
    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')
EnumSystemLocalesA = Fiddle::Function.new(
  lib['EnumSystemLocalesA'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleEnumProc : LOCALE_ENUMPROCA
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn EnumSystemLocalesA(
        lpLocaleEnumProc: *const core::ffi::c_void,  // LOCALE_ENUMPROCA
        dwFlags: u32  // DWORD
    ) -> 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 EnumSystemLocalesA(IntPtr lpLocaleEnumProc, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_EnumSystemLocalesA' -Namespace Win32 -PassThru
# $api::EnumSystemLocalesA(lpLocaleEnumProc, dwFlags)

#uselib "KERNEL32.dll"
#func global EnumSystemLocalesA "EnumSystemLocalesA" sptr, sptr
; EnumSystemLocalesA lpLocaleEnumProc, dwFlags   ; 戻り値は stat
; lpLocaleEnumProc : LOCALE_ENUMPROCA -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global EnumSystemLocalesA "EnumSystemLocalesA" sptr, int
; res = EnumSystemLocalesA(lpLocaleEnumProc, dwFlags)
; lpLocaleEnumProc : LOCALE_ENUMPROCA -> "sptr"
; dwFlags : DWORD -> "int"

; BOOL EnumSystemLocalesA(LOCALE_ENUMPROCA lpLocaleEnumProc, DWORD dwFlags)
#uselib "KERNEL32.dll"
#cfunc global EnumSystemLocalesA "EnumSystemLocalesA" intptr, int
; res = EnumSystemLocalesA(lpLocaleEnumProc, dwFlags)
; lpLocaleEnumProc : LOCALE_ENUMPROCA -> "intptr"
; dwFlags : DWORD -> "int"

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEnumSystemLocalesA = kernel32.NewProc("EnumSystemLocalesA")
)

// lpLocaleEnumProc (LOCALE_ENUMPROCA), dwFlags (DWORD)
r1, _, err := procEnumSystemLocalesA.Call(
	uintptr(lpLocaleEnumProc),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function EnumSystemLocalesA(
  lpLocaleEnumProc: Pointer;   // LOCALE_ENUMPROCA
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumSystemLocalesA';

result := DllCall("KERNEL32\EnumSystemLocalesA"
    , "Ptr", lpLocaleEnumProc   ; LOCALE_ENUMPROCA
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: BOOL

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

const std = @import("std");

extern "kernel32" fn EnumSystemLocalesA(
    lpLocaleEnumProc: ?*anyopaque, // LOCALE_ENUMPROCA
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;

proc EnumSystemLocalesA(
    lpLocaleEnumProc: pointer,  # LOCALE_ENUMPROCA
    dwFlags: uint32  # DWORD
): int32 {.importc: "EnumSystemLocalesA", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int EnumSystemLocalesA(
    void* lpLocaleEnumProc,   // LOCALE_ENUMPROCA
    uint dwFlags   // DWORD
);

ccall((:EnumSystemLocalesA, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32),
      lpLocaleEnumProc, dwFlags)
# lpLocaleEnumProc : LOCALE_ENUMPROCA -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

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

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

const lib = Deno.dlopen("KERNEL32.dll", {
  EnumSystemLocalesA: { parameters: ["pointer", "u32"], result: "i32" },
});
// lib.symbols.EnumSystemLocalesA(lpLocaleEnumProc, dwFlags)
// lpLocaleEnumProc : LOCALE_ENUMPROCA -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t EnumSystemLocalesA(
    void* lpLocaleEnumProc,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->EnumSystemLocalesA(lpLocaleEnumProc, dwFlags);
// lpLocaleEnumProc : LOCALE_ENUMPROCA
// 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.ASCII_OPTIONS);
    boolean EnumSystemLocalesA(
        Callback lpLocaleEnumProc,   // LOCALE_ENUMPROCA
        int dwFlags   // DWORD
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun EnumSystemLocalesA = EnumSystemLocalesA(
    lpLocaleEnumProc : Void*,   # LOCALE_ENUMPROCA
    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 EnumSystemLocalesANative = Int32 Function(Pointer<Void>, Uint32);
typedef EnumSystemLocalesADart = int Function(Pointer<Void>, int);
final EnumSystemLocalesA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<EnumSystemLocalesANative, EnumSystemLocalesADart>('EnumSystemLocalesA');
// lpLocaleEnumProc : LOCALE_ENUMPROCA -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function EnumSystemLocalesA(
  lpLocaleEnumProc: Pointer;   // LOCALE_ENUMPROCA
  dwFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumSystemLocalesA';

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

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

open Ctypes
open Foreign

let enumsystemlocalesa =
  foreign "EnumSystemLocalesA"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* lpLocaleEnumProc : LOCALE_ENUMPROCA -> (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 ("EnumSystemLocalesA" enum-system-locales-a :convention :stdcall) :int32
  (lp-locale-enum-proc :pointer)   ; LOCALE_ENUMPROCA
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

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