Win32 API 日本語リファレンス
ホームUI.Input.Ime › ImmEnumRegisterWordA

ImmEnumRegisterWordA

関数
IME辞書の登録単語を列挙する(ANSI版)。
DLLIMM32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD ImmEnumRegisterWordA(
    HKL param0,
    REGISTERWORDENUMPROCA param1,
    LPCSTR lpszReading,   // optional
    DWORD param3,
    LPCSTR lpszRegister,   // optional
    void* param5
);

パラメーター

名前方向説明
param0HKLin対象IMEのキーボードレイアウトハンドル(HKL)。
param1REGISTERWORDENUMPROCAin各登録単語ごとに呼ばれるコールバック関数(REGISTERWORDENUMPROCA)。
lpszReadingLPCSTRinoptional列挙する読み文字列へのポインターです。dwStyle および lpszRegister の設定に一致する利用可能なすべての読み文字列を列挙する場合、アプリケーションはこのパラメーターを NULL に設定します。
param3DWORDin列挙対象を絞り込むスタイル値。
lpszRegisterLPCSTRinoptional列挙する登録文字列へのポインターです。lpszReading および dwStyle の設定に一致するすべての登録文字列を列挙する場合、アプリケーションはこのパラメーターを NULL に設定します。
param5void*inoutコールバックに渡すアプリ定義データへのポインタ。

戻り値の型: DWORD

公式ドキュメント

ImmEnumRegisterWordA (ANSI) 関数 (immdev.h) は、指定した読み文字列、スタイル、登録文字列を持つ登録文字列を列挙します。

戻り値

コールバック関数が最後に返した値を返します。その意味はアプリケーションによって定義されます。登録文字列を列挙できない場合、この関数は 0 を返します。

解説(Remarks)

dwStyle が 0 に設定され、lpszReadinglpszRegister の両方が NULL に設定されている場合、この関数は IME 辞書内のすべての登録文字列を列挙します。

メモ

immdev.h ヘッダーは ImmEnumRegisterWord をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不整合が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

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

DWORD ImmEnumRegisterWordA(
    HKL param0,
    REGISTERWORDENUMPROCA param1,
    LPCSTR lpszReading,   // optional
    DWORD param3,
    LPCSTR lpszRegister,   // optional
    void* param5
);
[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ImmEnumRegisterWordA(
    IntPtr param0,   // HKL
    IntPtr param1,   // REGISTERWORDENUMPROCA
    [MarshalAs(UnmanagedType.LPStr)] string lpszReading,   // LPCSTR optional
    uint param3,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpszRegister,   // LPCSTR optional
    IntPtr param5   // void* in/out
);
<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmEnumRegisterWordA(
    param0 As IntPtr,   ' HKL
    param1 As IntPtr,   ' REGISTERWORDENUMPROCA
    <MarshalAs(UnmanagedType.LPStr)> lpszReading As String,   ' LPCSTR optional
    param3 As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszRegister As String,   ' LPCSTR optional
    param5 As IntPtr   ' void* in/out
) As UInteger
End Function
' param0 : HKL
' param1 : REGISTERWORDENUMPROCA
' lpszReading : LPCSTR optional
' param3 : DWORD
' lpszRegister : LPCSTR optional
' param5 : void* in/out
Declare PtrSafe Function ImmEnumRegisterWordA Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As LongPtr, _
    ByVal lpszReading As String, _
    ByVal param3 As Long, _
    ByVal lpszRegister As String, _
    ByVal param5 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImmEnumRegisterWordA = ctypes.windll.imm32.ImmEnumRegisterWordA
ImmEnumRegisterWordA.restype = wintypes.DWORD
ImmEnumRegisterWordA.argtypes = [
    wintypes.HANDLE,  # param0 : HKL
    ctypes.c_void_p,  # param1 : REGISTERWORDENUMPROCA
    wintypes.LPCSTR,  # lpszReading : LPCSTR optional
    wintypes.DWORD,  # param3 : DWORD
    wintypes.LPCSTR,  # lpszRegister : LPCSTR optional
    ctypes.POINTER(None),  # param5 : void* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmEnumRegisterWordA = Fiddle::Function.new(
  lib['ImmEnumRegisterWordA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HKL
    Fiddle::TYPE_VOIDP,  # param1 : REGISTERWORDENUMPROCA
    Fiddle::TYPE_VOIDP,  # lpszReading : LPCSTR optional
    -Fiddle::TYPE_INT,  # param3 : DWORD
    Fiddle::TYPE_VOIDP,  # lpszRegister : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # param5 : void* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "imm32")]
extern "system" {
    fn ImmEnumRegisterWordA(
        param0: *mut core::ffi::c_void,  // HKL
        param1: *const core::ffi::c_void,  // REGISTERWORDENUMPROCA
        lpszReading: *const u8,  // LPCSTR optional
        param3: u32,  // DWORD
        lpszRegister: *const u8,  // LPCSTR optional
        param5: *mut ()  // void* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Ansi)]
public static extern uint ImmEnumRegisterWordA(IntPtr param0, IntPtr param1, [MarshalAs(UnmanagedType.LPStr)] string lpszReading, uint param3, [MarshalAs(UnmanagedType.LPStr)] string lpszRegister, IntPtr param5);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmEnumRegisterWordA' -Namespace Win32 -PassThru
# $api::ImmEnumRegisterWordA(param0, param1, lpszReading, param3, lpszRegister, param5)
#uselib "IMM32.dll"
#func global ImmEnumRegisterWordA "ImmEnumRegisterWordA" sptr, sptr, sptr, sptr, sptr, sptr
; ImmEnumRegisterWordA param0, param1, lpszReading, param3, lpszRegister, param5   ; 戻り値は stat
; param0 : HKL -> "sptr"
; param1 : REGISTERWORDENUMPROCA -> "sptr"
; lpszReading : LPCSTR optional -> "sptr"
; param3 : DWORD -> "sptr"
; lpszRegister : LPCSTR optional -> "sptr"
; param5 : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IMM32.dll"
#cfunc global ImmEnumRegisterWordA "ImmEnumRegisterWordA" sptr, sptr, str, int, str, sptr
; res = ImmEnumRegisterWordA(param0, param1, lpszReading, param3, lpszRegister, param5)
; param0 : HKL -> "sptr"
; param1 : REGISTERWORDENUMPROCA -> "sptr"
; lpszReading : LPCSTR optional -> "str"
; param3 : DWORD -> "int"
; lpszRegister : LPCSTR optional -> "str"
; param5 : void* in/out -> "sptr"
; DWORD ImmEnumRegisterWordA(HKL param0, REGISTERWORDENUMPROCA param1, LPCSTR lpszReading, DWORD param3, LPCSTR lpszRegister, void* param5)
#uselib "IMM32.dll"
#cfunc global ImmEnumRegisterWordA "ImmEnumRegisterWordA" intptr, intptr, str, int, str, intptr
; res = ImmEnumRegisterWordA(param0, param1, lpszReading, param3, lpszRegister, param5)
; param0 : HKL -> "intptr"
; param1 : REGISTERWORDENUMPROCA -> "intptr"
; lpszReading : LPCSTR optional -> "str"
; param3 : DWORD -> "int"
; lpszRegister : LPCSTR optional -> "str"
; param5 : void* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmEnumRegisterWordA = imm32.NewProc("ImmEnumRegisterWordA")
)

// param0 (HKL), param1 (REGISTERWORDENUMPROCA), lpszReading (LPCSTR optional), param3 (DWORD), lpszRegister (LPCSTR optional), param5 (void* in/out)
r1, _, err := procImmEnumRegisterWordA.Call(
	uintptr(param0),
	uintptr(param1),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszReading))),
	uintptr(param3),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszRegister))),
	uintptr(param5),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ImmEnumRegisterWordA(
  param0: THandle;   // HKL
  param1: Pointer;   // REGISTERWORDENUMPROCA
  lpszReading: PAnsiChar;   // LPCSTR optional
  param3: DWORD;   // DWORD
  lpszRegister: PAnsiChar;   // LPCSTR optional
  param5: Pointer   // void* in/out
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmEnumRegisterWordA';
result := DllCall("IMM32\ImmEnumRegisterWordA"
    , "Ptr", param0   ; HKL
    , "Ptr", param1   ; REGISTERWORDENUMPROCA
    , "AStr", lpszReading   ; LPCSTR optional
    , "UInt", param3   ; DWORD
    , "AStr", lpszRegister   ; LPCSTR optional
    , "Ptr", param5   ; void* in/out
    , "UInt")   ; return: DWORD
●ImmEnumRegisterWordA(param0, param1, lpszReading, param3, lpszRegister, param5) = DLL("IMM32.dll", "dword ImmEnumRegisterWordA(void*, void*, char*, dword, char*, void*)")
# 呼び出し: ImmEnumRegisterWordA(param0, param1, lpszReading, param3, lpszRegister, param5)
# param0 : HKL -> "void*"
# param1 : REGISTERWORDENUMPROCA -> "void*"
# lpszReading : LPCSTR optional -> "char*"
# param3 : DWORD -> "dword"
# lpszRegister : LPCSTR optional -> "char*"
# param5 : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ImmEnumRegisterWordANative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>, Uint32, Pointer<Utf8>, Pointer<Void>);
typedef ImmEnumRegisterWordADart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>, int, Pointer<Utf8>, Pointer<Void>);
final ImmEnumRegisterWordA = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmEnumRegisterWordANative, ImmEnumRegisterWordADart>('ImmEnumRegisterWordA');
// param0 : HKL -> Pointer<Void>
// param1 : REGISTERWORDENUMPROCA -> Pointer<Void>
// lpszReading : LPCSTR optional -> Pointer<Utf8>
// param3 : DWORD -> Uint32
// lpszRegister : LPCSTR optional -> Pointer<Utf8>
// param5 : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmEnumRegisterWordA(
  param0: THandle;   // HKL
  param1: Pointer;   // REGISTERWORDENUMPROCA
  lpszReading: PAnsiChar;   // LPCSTR optional
  param3: DWORD;   // DWORD
  lpszRegister: PAnsiChar;   // LPCSTR optional
  param5: Pointer   // void* in/out
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmEnumRegisterWordA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmEnumRegisterWordA"
  c_ImmEnumRegisterWordA :: Ptr () -> Ptr () -> CString -> Word32 -> CString -> Ptr () -> IO Word32
-- param0 : HKL -> Ptr ()
-- param1 : REGISTERWORDENUMPROCA -> Ptr ()
-- lpszReading : LPCSTR optional -> CString
-- param3 : DWORD -> Word32
-- lpszRegister : LPCSTR optional -> CString
-- param5 : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immenumregisterworda =
  foreign "ImmEnumRegisterWordA"
    ((ptr void) @-> (ptr void) @-> string @-> uint32_t @-> string @-> (ptr void) @-> returning uint32_t)
(* param0 : HKL -> (ptr void) *)
(* param1 : REGISTERWORDENUMPROCA -> (ptr void) *)
(* lpszReading : LPCSTR optional -> string *)
(* param3 : DWORD -> uint32_t *)
(* lpszRegister : LPCSTR optional -> string *)
(* param5 : void* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

(cffi:defcfun ("ImmEnumRegisterWordA" imm-enum-register-word-a :convention :stdcall) :uint32
  (param0 :pointer)   ; HKL
  (param1 :pointer)   ; REGISTERWORDENUMPROCA
  (lpsz-reading :string)   ; LPCSTR optional
  (param3 :uint32)   ; DWORD
  (lpsz-register :string)   ; LPCSTR optional
  (param5 :pointer))   ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmEnumRegisterWordA = Win32::API::More->new('IMM32',
    'DWORD ImmEnumRegisterWordA(HANDLE param0, LPVOID param1, LPCSTR lpszReading, DWORD param3, LPCSTR lpszRegister, LPVOID param5)');
# my $ret = $ImmEnumRegisterWordA->Call($param0, $param1, $lpszReading, $param3, $lpszRegister, $param5);
# param0 : HKL -> HANDLE
# param1 : REGISTERWORDENUMPROCA -> LPVOID
# lpszReading : LPCSTR optional -> LPCSTR
# param3 : DWORD -> DWORD
# lpszRegister : LPCSTR optional -> LPCSTR
# param5 : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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