ホーム › UI.Input.Ime › ImmEnumRegisterWordW
ImmEnumRegisterWordW
関数IME辞書の登録単語を列挙する(Unicode版)。
シグネチャ
// IMM32.dll (Unicode / -W)
#include <windows.h>
DWORD ImmEnumRegisterWordW(
HKL param0,
REGISTERWORDENUMPROCW param1,
LPCWSTR lpszReading, // optional
DWORD param3,
LPCWSTR lpszRegister, // optional
void* param5
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| param0 | HKL | in | 対象IMEのキーボードレイアウトハンドル(HKL)。 |
| param1 | REGISTERWORDENUMPROCW | in | 各登録単語ごとに呼ばれるコールバック関数(REGISTERWORDENUMPROCW)。 |
| lpszReading | LPCWSTR | inoptional | 列挙する読み文字列へのポインター。dwStyle および lpszRegister の設定に一致する利用可能なすべての読み文字列を列挙する場合、アプリケーションはこのパラメーターを NULL に設定します。 |
| param3 | DWORD | in | 列挙対象を絞り込むスタイル値。 |
| lpszRegister | LPCWSTR | inoptional | 列挙する登録文字列へのポインター。lpszReading および dwStyle の設定に一致するすべての登録文字列を列挙する場合、アプリケーションはこのパラメーターを NULL に設定します。 |
| param5 | void* | inout | コールバックに渡すアプリ定義データへのポインタ。 |
戻り値の型: DWORD
公式ドキュメント
ImmEnumRegisterWordW (Unicode) 関数 (immdev.h) は、指定された読み文字列、スタイル、登録文字列を持つ登録文字列を列挙します。
戻り値
コールバック関数が最後に返した値を返します。その意味はアプリケーションによって定義されます。登録文字列を列挙できない場合、この関数は 0 を返します。
解説(Remarks)
dwStyle が 0 に設定され、lpszReading と lpszRegister の両方が NULL に設定されている場合、この関数は IME 辞書内のすべての登録文字列を列挙します。
メモ
immdev.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ImmEnumRegisterWord を定義します。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IMM32.dll (Unicode / -W)
#include <windows.h>
DWORD ImmEnumRegisterWordW(
HKL param0,
REGISTERWORDENUMPROCW param1,
LPCWSTR lpszReading, // optional
DWORD param3,
LPCWSTR lpszRegister, // optional
void* param5
);[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint ImmEnumRegisterWordW(
IntPtr param0, // HKL
IntPtr param1, // REGISTERWORDENUMPROCW
[MarshalAs(UnmanagedType.LPWStr)] string lpszReading, // LPCWSTR optional
uint param3, // DWORD
[MarshalAs(UnmanagedType.LPWStr)] string lpszRegister, // LPCWSTR optional
IntPtr param5 // void* in/out
);<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmEnumRegisterWordW(
param0 As IntPtr, ' HKL
param1 As IntPtr, ' REGISTERWORDENUMPROCW
<MarshalAs(UnmanagedType.LPWStr)> lpszReading As String, ' LPCWSTR optional
param3 As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPWStr)> lpszRegister As String, ' LPCWSTR optional
param5 As IntPtr ' void* in/out
) As UInteger
End Function' param0 : HKL
' param1 : REGISTERWORDENUMPROCW
' lpszReading : LPCWSTR optional
' param3 : DWORD
' lpszRegister : LPCWSTR optional
' param5 : void* in/out
Declare PtrSafe Function ImmEnumRegisterWordW Lib "imm32" ( _
ByVal param0 As LongPtr, _
ByVal param1 As LongPtr, _
ByVal lpszReading As LongPtr, _
ByVal param3 As Long, _
ByVal lpszRegister As LongPtr, _
ByVal param5 As LongPtr) 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
ImmEnumRegisterWordW = ctypes.windll.imm32.ImmEnumRegisterWordW
ImmEnumRegisterWordW.restype = wintypes.DWORD
ImmEnumRegisterWordW.argtypes = [
wintypes.HANDLE, # param0 : HKL
ctypes.c_void_p, # param1 : REGISTERWORDENUMPROCW
wintypes.LPCWSTR, # lpszReading : LPCWSTR optional
wintypes.DWORD, # param3 : DWORD
wintypes.LPCWSTR, # lpszRegister : LPCWSTR optional
ctypes.POINTER(None), # param5 : void* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IMM32.dll')
ImmEnumRegisterWordW = Fiddle::Function.new(
lib['ImmEnumRegisterWordW'],
[
Fiddle::TYPE_VOIDP, # param0 : HKL
Fiddle::TYPE_VOIDP, # param1 : REGISTERWORDENUMPROCW
Fiddle::TYPE_VOIDP, # lpszReading : LPCWSTR optional
-Fiddle::TYPE_INT, # param3 : DWORD
Fiddle::TYPE_VOIDP, # lpszRegister : LPCWSTR optional
Fiddle::TYPE_VOIDP, # param5 : void* in/out
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "imm32")]
extern "system" {
fn ImmEnumRegisterWordW(
param0: *mut core::ffi::c_void, // HKL
param1: *const core::ffi::c_void, // REGISTERWORDENUMPROCW
lpszReading: *const u16, // LPCWSTR optional
param3: u32, // DWORD
lpszRegister: *const u16, // LPCWSTR optional
param5: *mut () // void* in/out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Unicode)]
public static extern uint ImmEnumRegisterWordW(IntPtr param0, IntPtr param1, [MarshalAs(UnmanagedType.LPWStr)] string lpszReading, uint param3, [MarshalAs(UnmanagedType.LPWStr)] string lpszRegister, IntPtr param5);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmEnumRegisterWordW' -Namespace Win32 -PassThru
# $api::ImmEnumRegisterWordW(param0, param1, lpszReading, param3, lpszRegister, param5)#uselib "IMM32.dll"
#func global ImmEnumRegisterWordW "ImmEnumRegisterWordW" wptr, wptr, wptr, wptr, wptr, wptr
; ImmEnumRegisterWordW param0, param1, lpszReading, param3, lpszRegister, param5 ; 戻り値は stat
; param0 : HKL -> "wptr"
; param1 : REGISTERWORDENUMPROCW -> "wptr"
; lpszReading : LPCWSTR optional -> "wptr"
; param3 : DWORD -> "wptr"
; lpszRegister : LPCWSTR optional -> "wptr"
; param5 : void* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IMM32.dll"
#cfunc global ImmEnumRegisterWordW "ImmEnumRegisterWordW" sptr, sptr, wstr, int, wstr, sptr
; res = ImmEnumRegisterWordW(param0, param1, lpszReading, param3, lpszRegister, param5)
; param0 : HKL -> "sptr"
; param1 : REGISTERWORDENUMPROCW -> "sptr"
; lpszReading : LPCWSTR optional -> "wstr"
; param3 : DWORD -> "int"
; lpszRegister : LPCWSTR optional -> "wstr"
; param5 : void* in/out -> "sptr"; DWORD ImmEnumRegisterWordW(HKL param0, REGISTERWORDENUMPROCW param1, LPCWSTR lpszReading, DWORD param3, LPCWSTR lpszRegister, void* param5)
#uselib "IMM32.dll"
#cfunc global ImmEnumRegisterWordW "ImmEnumRegisterWordW" intptr, intptr, wstr, int, wstr, intptr
; res = ImmEnumRegisterWordW(param0, param1, lpszReading, param3, lpszRegister, param5)
; param0 : HKL -> "intptr"
; param1 : REGISTERWORDENUMPROCW -> "intptr"
; lpszReading : LPCWSTR optional -> "wstr"
; param3 : DWORD -> "int"
; lpszRegister : LPCWSTR optional -> "wstr"
; param5 : void* in/out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
imm32 = windows.NewLazySystemDLL("IMM32.dll")
procImmEnumRegisterWordW = imm32.NewProc("ImmEnumRegisterWordW")
)
// param0 (HKL), param1 (REGISTERWORDENUMPROCW), lpszReading (LPCWSTR optional), param3 (DWORD), lpszRegister (LPCWSTR optional), param5 (void* in/out)
r1, _, err := procImmEnumRegisterWordW.Call(
uintptr(param0),
uintptr(param1),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszReading))),
uintptr(param3),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszRegister))),
uintptr(param5),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction ImmEnumRegisterWordW(
param0: THandle; // HKL
param1: Pointer; // REGISTERWORDENUMPROCW
lpszReading: PWideChar; // LPCWSTR optional
param3: DWORD; // DWORD
lpszRegister: PWideChar; // LPCWSTR optional
param5: Pointer // void* in/out
): DWORD; stdcall;
external 'IMM32.dll' name 'ImmEnumRegisterWordW';result := DllCall("IMM32\ImmEnumRegisterWordW"
, "Ptr", param0 ; HKL
, "Ptr", param1 ; REGISTERWORDENUMPROCW
, "WStr", lpszReading ; LPCWSTR optional
, "UInt", param3 ; DWORD
, "WStr", lpszRegister ; LPCWSTR optional
, "Ptr", param5 ; void* in/out
, "UInt") ; return: DWORD●ImmEnumRegisterWordW(param0, param1, lpszReading, param3, lpszRegister, param5) = DLL("IMM32.dll", "dword ImmEnumRegisterWordW(void*, void*, char*, dword, char*, void*)")
# 呼び出し: ImmEnumRegisterWordW(param0, param1, lpszReading, param3, lpszRegister, param5)
# param0 : HKL -> "void*"
# param1 : REGISTERWORDENUMPROCW -> "void*"
# lpszReading : LPCWSTR optional -> "char*"
# param3 : DWORD -> "dword"
# lpszRegister : LPCWSTR optional -> "char*"
# param5 : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "imm32" fn ImmEnumRegisterWordW(
param0: ?*anyopaque, // HKL
param1: ?*anyopaque, // REGISTERWORDENUMPROCW
lpszReading: [*c]const u16, // LPCWSTR optional
param3: u32, // DWORD
lpszRegister: [*c]const u16, // LPCWSTR optional
param5: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc ImmEnumRegisterWordW(
param0: pointer, # HKL
param1: pointer, # REGISTERWORDENUMPROCW
lpszReading: WideCString, # LPCWSTR optional
param3: uint32, # DWORD
lpszRegister: WideCString, # LPCWSTR optional
param5: pointer # void* in/out
): uint32 {.importc: "ImmEnumRegisterWordW", stdcall, dynlib: "IMM32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "imm32");
extern(Windows)
uint ImmEnumRegisterWordW(
void* param0, // HKL
void* param1, // REGISTERWORDENUMPROCW
const(wchar)* lpszReading, // LPCWSTR optional
uint param3, // DWORD
const(wchar)* lpszRegister, // LPCWSTR optional
void* param5 // void* in/out
);ccall((:ImmEnumRegisterWordW, "IMM32.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Ptr{Cvoid}, Cwstring, UInt32, Cwstring, Ptr{Cvoid}),
param0, param1, lpszReading, param3, lpszRegister, param5)
# param0 : HKL -> Ptr{Cvoid}
# param1 : REGISTERWORDENUMPROCW -> Ptr{Cvoid}
# lpszReading : LPCWSTR optional -> Cwstring
# param3 : DWORD -> UInt32
# lpszRegister : LPCWSTR optional -> Cwstring
# param5 : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t ImmEnumRegisterWordW(
void* param0,
void* param1,
const uint16_t* lpszReading,
uint32_t param3,
const uint16_t* lpszRegister,
void* param5);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmEnumRegisterWordW(param0, param1, lpszReading, param3, lpszRegister, param5)
-- param0 : HKL
-- param1 : REGISTERWORDENUMPROCW
-- lpszReading : LPCWSTR optional
-- param3 : DWORD
-- lpszRegister : LPCWSTR optional
-- param5 : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmEnumRegisterWordW = lib.func('__stdcall', 'ImmEnumRegisterWordW', 'uint32_t', ['void *', 'void *', 'str16', 'uint32_t', 'str16', 'void *']);
// ImmEnumRegisterWordW(param0, param1, lpszReading, param3, lpszRegister, param5)
// param0 : HKL -> 'void *'
// param1 : REGISTERWORDENUMPROCW -> 'void *'
// lpszReading : LPCWSTR optional -> 'str16'
// param3 : DWORD -> 'uint32_t'
// lpszRegister : LPCWSTR optional -> 'str16'
// param5 : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("IMM32.dll", {
ImmEnumRegisterWordW: { parameters: ["pointer", "pointer", "buffer", "u32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.ImmEnumRegisterWordW(param0, param1, lpszReading, param3, lpszRegister, param5)
// param0 : HKL -> "pointer"
// param1 : REGISTERWORDENUMPROCW -> "pointer"
// lpszReading : LPCWSTR optional -> "buffer"
// param3 : DWORD -> "u32"
// lpszRegister : LPCWSTR optional -> "buffer"
// param5 : void* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t ImmEnumRegisterWordW(
void* param0,
void* param1,
const uint16_t* lpszReading,
uint32_t param3,
const uint16_t* lpszRegister,
void* param5);
C, "IMM32.dll");
// $ffi->ImmEnumRegisterWordW(param0, param1, lpszReading, param3, lpszRegister, param5);
// param0 : HKL
// param1 : REGISTERWORDENUMPROCW
// lpszReading : LPCWSTR optional
// param3 : DWORD
// lpszRegister : LPCWSTR 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.UNICODE_OPTIONS);
int ImmEnumRegisterWordW(
Pointer param0, // HKL
Callback param1, // REGISTERWORDENUMPROCW
WString lpszReading, // LPCWSTR optional
int param3, // DWORD
WString lpszRegister, // LPCWSTR optional
Pointer param5 // void* in/out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("imm32")]
lib LibIMM32
fun ImmEnumRegisterWordW = ImmEnumRegisterWordW(
param0 : Void*, # HKL
param1 : Void*, # REGISTERWORDENUMPROCW
lpszReading : UInt16*, # LPCWSTR optional
param3 : UInt32, # DWORD
lpszRegister : UInt16*, # LPCWSTR 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 ImmEnumRegisterWordWNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Utf16>, Pointer<Void>);
typedef ImmEnumRegisterWordWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, int, Pointer<Utf16>, Pointer<Void>);
final ImmEnumRegisterWordW = DynamicLibrary.open('IMM32.dll')
.lookupFunction<ImmEnumRegisterWordWNative, ImmEnumRegisterWordWDart>('ImmEnumRegisterWordW');
// param0 : HKL -> Pointer<Void>
// param1 : REGISTERWORDENUMPROCW -> Pointer<Void>
// lpszReading : LPCWSTR optional -> Pointer<Utf16>
// param3 : DWORD -> Uint32
// lpszRegister : LPCWSTR optional -> Pointer<Utf16>
// param5 : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ImmEnumRegisterWordW(
param0: THandle; // HKL
param1: Pointer; // REGISTERWORDENUMPROCW
lpszReading: PWideChar; // LPCWSTR optional
param3: DWORD; // DWORD
lpszRegister: PWideChar; // LPCWSTR optional
param5: Pointer // void* in/out
): DWORD; stdcall;
external 'IMM32.dll' name 'ImmEnumRegisterWordW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ImmEnumRegisterWordW"
c_ImmEnumRegisterWordW :: Ptr () -> Ptr () -> CWString -> Word32 -> CWString -> Ptr () -> IO Word32
-- param0 : HKL -> Ptr ()
-- param1 : REGISTERWORDENUMPROCW -> Ptr ()
-- lpszReading : LPCWSTR optional -> CWString
-- param3 : DWORD -> Word32
-- lpszRegister : LPCWSTR optional -> CWString
-- param5 : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let immenumregisterwordw =
foreign "ImmEnumRegisterWordW"
((ptr void) @-> (ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* param0 : HKL -> (ptr void) *)
(* param1 : REGISTERWORDENUMPROCW -> (ptr void) *)
(* lpszReading : LPCWSTR optional -> (ptr uint16_t) *)
(* param3 : DWORD -> uint32_t *)
(* lpszRegister : LPCWSTR optional -> (ptr uint16_t) *)
(* 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 ("ImmEnumRegisterWordW" imm-enum-register-word-w :convention :stdcall) :uint32
(param0 :pointer) ; HKL
(param1 :pointer) ; REGISTERWORDENUMPROCW
(lpsz-reading (:string :encoding :utf-16le)) ; LPCWSTR optional
(param3 :uint32) ; DWORD
(lpsz-register (:string :encoding :utf-16le)) ; LPCWSTR optional
(param5 :pointer)) ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ImmEnumRegisterWordW = Win32::API::More->new('IMM32',
'DWORD ImmEnumRegisterWordW(HANDLE param0, LPVOID param1, LPCWSTR lpszReading, DWORD param3, LPCWSTR lpszRegister, LPVOID param5)');
# my $ret = $ImmEnumRegisterWordW->Call($param0, $param1, $lpszReading, $param3, $lpszRegister, $param5);
# param0 : HKL -> HANDLE
# param1 : REGISTERWORDENUMPROCW -> LPVOID
# lpszReading : LPCWSTR optional -> LPCWSTR
# param3 : DWORD -> DWORD
# lpszRegister : LPCWSTR optional -> LPCWSTR
# param5 : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f ImmEnumRegisterWordA (ANSI版) — IME辞書の登録単語を列挙する(ANSI版)。