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

EnumSystemCodePagesA

関数
システムにインストールされたコードページをANSIで列挙する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL EnumSystemCodePagesA(
    CODEPAGE_ENUMPROCA lpCodePageEnumProc,
    ENUM_SYSTEM_CODE_PAGES_FLAGS dwFlags
);

パラメーター

名前型方向説明
lpCodePageEnumProcCODEPAGE_ENUMPROCAinアプリケーション定義のコールバック関数へのポインターです。EnumSystemCodePages 関数は、このコールバック関数を繰り返し呼び出すことでコードページを列挙します。詳細については、EnumCodePagesProc を参照してください。
dwFlagsENUM_SYSTEM_CODE_PAGES_FLAGSin

列挙するコードページを指定するフラグです。このパラメーターには、次のいずれかの値を指定できます。これらの値は相互に排他的です。

値 意味
CP_INSTALLED
 インストールされているコードページのみを列挙します。
CP_SUPPORTED
 サポートされているすべてのコードページを列挙します。

戻り値の型: BOOL

公式ドキュメント

オペレーティングシステムにインストールされている、またはサポートされているコードページを列挙します。(ANSI)

戻り値

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

解説(Remarks)

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

アプリケーションがこの関数を使用してデータ保存に適切なコードページを判断する場合は、可能な限り Unicode を使用してください。その他のコードページは、関連する規格の実装がベンダーやオペレーティングシステムによって異なるため、Unicode ほど移植性が高くありません。

メモ

winnls.h ヘッダーは EnumSystemCodePages をエイリアスとして定義しており、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 EnumSystemCodePagesA(
    CODEPAGE_ENUMPROCA lpCodePageEnumProc,
    ENUM_SYSTEM_CODE_PAGES_FLAGS dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool EnumSystemCodePagesA(
    IntPtr lpCodePageEnumProc,   // CODEPAGE_ENUMPROCA
    uint dwFlags   // ENUM_SYSTEM_CODE_PAGES_FLAGS
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumSystemCodePagesA(
    lpCodePageEnumProc As IntPtr,   ' CODEPAGE_ENUMPROCA
    dwFlags As UInteger   ' ENUM_SYSTEM_CODE_PAGES_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpCodePageEnumProc : CODEPAGE_ENUMPROCA
' dwFlags : ENUM_SYSTEM_CODE_PAGES_FLAGS
Declare PtrSafe Function EnumSystemCodePagesA Lib "kernel32" ( _
    ByVal lpCodePageEnumProc 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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEnumSystemCodePagesA = kernel32.NewProc("EnumSystemCodePagesA")
)

// lpCodePageEnumProc (CODEPAGE_ENUMPROCA), dwFlags (ENUM_SYSTEM_CODE_PAGES_FLAGS)
r1, _, err := procEnumSystemCodePagesA.Call(
	uintptr(lpCodePageEnumProc),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EnumSystemCodePagesA(
  lpCodePageEnumProc: Pointer;   // CODEPAGE_ENUMPROCA
  dwFlags: DWORD   // ENUM_SYSTEM_CODE_PAGES_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'EnumSystemCodePagesA';
result := DllCall("KERNEL32\EnumSystemCodePagesA"
    , "Ptr", lpCodePageEnumProc   ; CODEPAGE_ENUMPROCA
    , "UInt", dwFlags   ; ENUM_SYSTEM_CODE_PAGES_FLAGS
    , "Int")   ; return: BOOL
●EnumSystemCodePagesA(lpCodePageEnumProc, dwFlags) = DLL("KERNEL32.dll", "bool EnumSystemCodePagesA(void*, dword)")
# 呼び出し: EnumSystemCodePagesA(lpCodePageEnumProc, dwFlags)
# lpCodePageEnumProc : CODEPAGE_ENUMPROCA -> "void*"
# dwFlags : ENUM_SYSTEM_CODE_PAGES_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn EnumSystemCodePagesA(
    lpCodePageEnumProc: ?*anyopaque, // CODEPAGE_ENUMPROCA
    dwFlags: u32 // ENUM_SYSTEM_CODE_PAGES_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc EnumSystemCodePagesA(
    lpCodePageEnumProc: pointer,  # CODEPAGE_ENUMPROCA
    dwFlags: uint32  # ENUM_SYSTEM_CODE_PAGES_FLAGS
): int32 {.importc: "EnumSystemCodePagesA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int EnumSystemCodePagesA(
    void* lpCodePageEnumProc,   // CODEPAGE_ENUMPROCA
    uint dwFlags   // ENUM_SYSTEM_CODE_PAGES_FLAGS
);
ccall((:EnumSystemCodePagesA, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32),
      lpCodePageEnumProc, dwFlags)
# lpCodePageEnumProc : CODEPAGE_ENUMPROCA -> Ptr{Cvoid}
# dwFlags : ENUM_SYSTEM_CODE_PAGES_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t EnumSystemCodePagesA(
    void* lpCodePageEnumProc,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.EnumSystemCodePagesA(lpCodePageEnumProc, dwFlags)
-- lpCodePageEnumProc : CODEPAGE_ENUMPROCA
-- dwFlags : ENUM_SYSTEM_CODE_PAGES_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const EnumSystemCodePagesA = lib.func('__stdcall', 'EnumSystemCodePagesA', 'int32_t', ['void *', 'uint32_t']);
// EnumSystemCodePagesA(lpCodePageEnumProc, dwFlags)
// lpCodePageEnumProc : CODEPAGE_ENUMPROCA -> 'void *'
// dwFlags : ENUM_SYSTEM_CODE_PAGES_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("KERNEL32.dll", {
  EnumSystemCodePagesA: { parameters: ["pointer", "u32"], result: "i32" },
});
// lib.symbols.EnumSystemCodePagesA(lpCodePageEnumProc, dwFlags)
// lpCodePageEnumProc : CODEPAGE_ENUMPROCA -> "pointer"
// dwFlags : ENUM_SYSTEM_CODE_PAGES_FLAGS -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EnumSystemCodePagesA(
    void* lpCodePageEnumProc,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->EnumSystemCodePagesA(lpCodePageEnumProc, dwFlags);
// lpCodePageEnumProc : CODEPAGE_ENUMPROCA
// dwFlags : ENUM_SYSTEM_CODE_PAGES_FLAGS
// 構造体/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 EnumSystemCodePagesA(
        Callback lpCodePageEnumProc,   // CODEPAGE_ENUMPROCA
        int dwFlags   // ENUM_SYSTEM_CODE_PAGES_FLAGS
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun EnumSystemCodePagesA = EnumSystemCodePagesA(
    lpCodePageEnumProc : Void*,   # CODEPAGE_ENUMPROCA
    dwFlags : UInt32   # ENUM_SYSTEM_CODE_PAGES_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("EnumSystemCodePagesA" enum-system-code-pages-a :convention :stdcall) :int32
  (lp-code-page-enum-proc :pointer)   ; CODEPAGE_ENUMPROCA
  (dw-flags :uint32))   ; ENUM_SYSTEM_CODE_PAGES_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumSystemCodePagesA = Win32::API::More->new('KERNEL32',
    'BOOL EnumSystemCodePagesA(LPVOID lpCodePageEnumProc, DWORD dwFlags)');
# my $ret = $EnumSystemCodePagesA->Call($lpCodePageEnumProc, $dwFlags);
# lpCodePageEnumProc : CODEPAGE_ENUMPROCA -> LPVOID
# dwFlags : ENUM_SYSTEM_CODE_PAGES_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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