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

ImmGetConversionListW

関数
文字列に対する変換候補の一覧を取得する(Unicode版)。
DLLIMM32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD ImmGetConversionListW(
    HKL param0,
    HIMC param1,
    LPCWSTR lpSrc,
    CANDIDATELIST* lpDst,
    DWORD dwBufLen,
    GET_CONVERSION_LIST_FLAG uFlag
);

パラメーター

名前方向説明
param0HKLin対象IMEのキーボードレイアウトハンドル(HKL)。
param1HIMCin対象の入力コンテキストハンドル(HIMC)。NULL指定も可能。
lpSrcLPCWSTRinリストの元となる文字列を指定する、null 終端文字列へのポインターです。
lpDstCANDIDATELIST*out関数がリストを取得する CANDIDATELIST 構造体へのポインターです。
dwBufLenDWORDin出力バッファーのサイズ(バイト単位)です。完全な変換結果リストに必要なバッファーサイズを関数に返させる場合、アプリケーションはこのパラメーターに 0 を設定します。
uFlagGET_CONVERSION_LIST_FLAGin

動作フラグです。このパラメーターには次のいずれかの値を指定できます。

意味
GCL_CONVERSION
元の文字列は読み文字列です。関数は結果文字列を宛先バッファーにコピーします。
GCL_REVERSECONVERSION
元の文字列は結果文字列です。関数は読み文字列を宛先バッファーにコピーします。
GCL_REVERSE_LENGTH
元の文字列は結果文字列です。GCL_REVERSECONVERSION が指定された場合に作成される読み文字列のサイズ(バイト単位)を関数が返します。

戻り値の型: DWORD

公式ドキュメント

ImmGetConversionListW (Unicode) 関数 (immdev.h) は、IME 関連メッセージを生成することなく、文字または単語の変換結果リストを取得します。

戻り値

出力バッファーにコピーされたバイト数を返します。アプリケーションが dwBufLen パラメーターに 0 を設定した場合、関数は必要な出力バッファーのサイズ(バイト単位)を返します。

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

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

DWORD ImmGetConversionListW(
    HKL param0,
    HIMC param1,
    LPCWSTR lpSrc,
    CANDIDATELIST* lpDst,
    DWORD dwBufLen,
    GET_CONVERSION_LIST_FLAG uFlag
);
[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint ImmGetConversionListW(
    IntPtr param0,   // HKL
    IntPtr param1,   // HIMC
    [MarshalAs(UnmanagedType.LPWStr)] string lpSrc,   // LPCWSTR
    IntPtr lpDst,   // CANDIDATELIST* out
    uint dwBufLen,   // DWORD
    uint uFlag   // GET_CONVERSION_LIST_FLAG
);
<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmGetConversionListW(
    param0 As IntPtr,   ' HKL
    param1 As IntPtr,   ' HIMC
    <MarshalAs(UnmanagedType.LPWStr)> lpSrc As String,   ' LPCWSTR
    lpDst As IntPtr,   ' CANDIDATELIST* out
    dwBufLen As UInteger,   ' DWORD
    uFlag As UInteger   ' GET_CONVERSION_LIST_FLAG
) As UInteger
End Function
' param0 : HKL
' param1 : HIMC
' lpSrc : LPCWSTR
' lpDst : CANDIDATELIST* out
' dwBufLen : DWORD
' uFlag : GET_CONVERSION_LIST_FLAG
Declare PtrSafe Function ImmGetConversionListW Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As LongPtr, _
    ByVal lpSrc As LongPtr, _
    ByVal lpDst As LongPtr, _
    ByVal dwBufLen As Long, _
    ByVal uFlag 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

ImmGetConversionListW = ctypes.windll.imm32.ImmGetConversionListW
ImmGetConversionListW.restype = wintypes.DWORD
ImmGetConversionListW.argtypes = [
    wintypes.HANDLE,  # param0 : HKL
    wintypes.HANDLE,  # param1 : HIMC
    wintypes.LPCWSTR,  # lpSrc : LPCWSTR
    ctypes.c_void_p,  # lpDst : CANDIDATELIST* out
    wintypes.DWORD,  # dwBufLen : DWORD
    wintypes.DWORD,  # uFlag : GET_CONVERSION_LIST_FLAG
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetConversionListW = Fiddle::Function.new(
  lib['ImmGetConversionListW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HKL
    Fiddle::TYPE_VOIDP,  # param1 : HIMC
    Fiddle::TYPE_VOIDP,  # lpSrc : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpDst : CANDIDATELIST* out
    -Fiddle::TYPE_INT,  # dwBufLen : DWORD
    -Fiddle::TYPE_INT,  # uFlag : GET_CONVERSION_LIST_FLAG
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "imm32")]
extern "system" {
    fn ImmGetConversionListW(
        param0: *mut core::ffi::c_void,  // HKL
        param1: *mut core::ffi::c_void,  // HIMC
        lpSrc: *const u16,  // LPCWSTR
        lpDst: *mut CANDIDATELIST,  // CANDIDATELIST* out
        dwBufLen: u32,  // DWORD
        uFlag: u32  // GET_CONVERSION_LIST_FLAG
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Unicode)]
public static extern uint ImmGetConversionListW(IntPtr param0, IntPtr param1, [MarshalAs(UnmanagedType.LPWStr)] string lpSrc, IntPtr lpDst, uint dwBufLen, uint uFlag);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetConversionListW' -Namespace Win32 -PassThru
# $api::ImmGetConversionListW(param0, param1, lpSrc, lpDst, dwBufLen, uFlag)
#uselib "IMM32.dll"
#func global ImmGetConversionListW "ImmGetConversionListW" wptr, wptr, wptr, wptr, wptr, wptr
; ImmGetConversionListW param0, param1, lpSrc, varptr(lpDst), dwBufLen, uFlag   ; 戻り値は stat
; param0 : HKL -> "wptr"
; param1 : HIMC -> "wptr"
; lpSrc : LPCWSTR -> "wptr"
; lpDst : CANDIDATELIST* out -> "wptr"
; dwBufLen : DWORD -> "wptr"
; uFlag : GET_CONVERSION_LIST_FLAG -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IMM32.dll"
#cfunc global ImmGetConversionListW "ImmGetConversionListW" sptr, sptr, wstr, var, int, int
; res = ImmGetConversionListW(param0, param1, lpSrc, lpDst, dwBufLen, uFlag)
; param0 : HKL -> "sptr"
; param1 : HIMC -> "sptr"
; lpSrc : LPCWSTR -> "wstr"
; lpDst : CANDIDATELIST* out -> "var"
; dwBufLen : DWORD -> "int"
; uFlag : GET_CONVERSION_LIST_FLAG -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD ImmGetConversionListW(HKL param0, HIMC param1, LPCWSTR lpSrc, CANDIDATELIST* lpDst, DWORD dwBufLen, GET_CONVERSION_LIST_FLAG uFlag)
#uselib "IMM32.dll"
#cfunc global ImmGetConversionListW "ImmGetConversionListW" intptr, intptr, wstr, var, int, int
; res = ImmGetConversionListW(param0, param1, lpSrc, lpDst, dwBufLen, uFlag)
; param0 : HKL -> "intptr"
; param1 : HIMC -> "intptr"
; lpSrc : LPCWSTR -> "wstr"
; lpDst : CANDIDATELIST* out -> "var"
; dwBufLen : DWORD -> "int"
; uFlag : GET_CONVERSION_LIST_FLAG -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmGetConversionListW = imm32.NewProc("ImmGetConversionListW")
)

// param0 (HKL), param1 (HIMC), lpSrc (LPCWSTR), lpDst (CANDIDATELIST* out), dwBufLen (DWORD), uFlag (GET_CONVERSION_LIST_FLAG)
r1, _, err := procImmGetConversionListW.Call(
	uintptr(param0),
	uintptr(param1),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpSrc))),
	uintptr(lpDst),
	uintptr(dwBufLen),
	uintptr(uFlag),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ImmGetConversionListW(
  param0: THandle;   // HKL
  param1: THandle;   // HIMC
  lpSrc: PWideChar;   // LPCWSTR
  lpDst: Pointer;   // CANDIDATELIST* out
  dwBufLen: DWORD;   // DWORD
  uFlag: DWORD   // GET_CONVERSION_LIST_FLAG
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmGetConversionListW';
result := DllCall("IMM32\ImmGetConversionListW"
    , "Ptr", param0   ; HKL
    , "Ptr", param1   ; HIMC
    , "WStr", lpSrc   ; LPCWSTR
    , "Ptr", lpDst   ; CANDIDATELIST* out
    , "UInt", dwBufLen   ; DWORD
    , "UInt", uFlag   ; GET_CONVERSION_LIST_FLAG
    , "UInt")   ; return: DWORD
●ImmGetConversionListW(param0, param1, lpSrc, lpDst, dwBufLen, uFlag) = DLL("IMM32.dll", "dword ImmGetConversionListW(void*, void*, char*, void*, dword, dword)")
# 呼び出し: ImmGetConversionListW(param0, param1, lpSrc, lpDst, dwBufLen, uFlag)
# param0 : HKL -> "void*"
# param1 : HIMC -> "void*"
# lpSrc : LPCWSTR -> "char*"
# lpDst : CANDIDATELIST* out -> "void*"
# dwBufLen : DWORD -> "dword"
# uFlag : GET_CONVERSION_LIST_FLAG -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

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

typedef ImmGetConversionListWNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Uint32, Uint32);
typedef ImmGetConversionListWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Pointer<Void>, int, int);
final ImmGetConversionListW = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmGetConversionListWNative, ImmGetConversionListWDart>('ImmGetConversionListW');
// param0 : HKL -> Pointer<Void>
// param1 : HIMC -> Pointer<Void>
// lpSrc : LPCWSTR -> Pointer<Utf16>
// lpDst : CANDIDATELIST* out -> Pointer<Void>
// dwBufLen : DWORD -> Uint32
// uFlag : GET_CONVERSION_LIST_FLAG -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmGetConversionListW(
  param0: THandle;   // HKL
  param1: THandle;   // HIMC
  lpSrc: PWideChar;   // LPCWSTR
  lpDst: Pointer;   // CANDIDATELIST* out
  dwBufLen: DWORD;   // DWORD
  uFlag: DWORD   // GET_CONVERSION_LIST_FLAG
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmGetConversionListW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmGetConversionListW"
  c_ImmGetConversionListW :: Ptr () -> Ptr () -> CWString -> Ptr () -> Word32 -> Word32 -> IO Word32
-- param0 : HKL -> Ptr ()
-- param1 : HIMC -> Ptr ()
-- lpSrc : LPCWSTR -> CWString
-- lpDst : CANDIDATELIST* out -> Ptr ()
-- dwBufLen : DWORD -> Word32
-- uFlag : GET_CONVERSION_LIST_FLAG -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immgetconversionlistw =
  foreign "ImmGetConversionListW"
    ((ptr void) @-> (ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* param0 : HKL -> (ptr void) *)
(* param1 : HIMC -> (ptr void) *)
(* lpSrc : LPCWSTR -> (ptr uint16_t) *)
(* lpDst : CANDIDATELIST* out -> (ptr void) *)
(* dwBufLen : DWORD -> uint32_t *)
(* uFlag : GET_CONVERSION_LIST_FLAG -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

(cffi:defcfun ("ImmGetConversionListW" imm-get-conversion-list-w :convention :stdcall) :uint32
  (param0 :pointer)   ; HKL
  (param1 :pointer)   ; HIMC
  (lp-src (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-dst :pointer)   ; CANDIDATELIST* out
  (dw-buf-len :uint32)   ; DWORD
  (u-flag :uint32))   ; GET_CONVERSION_LIST_FLAG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmGetConversionListW = Win32::API::More->new('IMM32',
    'DWORD ImmGetConversionListW(HANDLE param0, HANDLE param1, LPCWSTR lpSrc, LPVOID lpDst, DWORD dwBufLen, DWORD uFlag)');
# my $ret = $ImmGetConversionListW->Call($param0, $param1, $lpSrc, $lpDst, $dwBufLen, $uFlag);
# param0 : HKL -> HANDLE
# param1 : HIMC -> HANDLE
# lpSrc : LPCWSTR -> LPCWSTR
# lpDst : CANDIDATELIST* out -> LPVOID
# dwBufLen : DWORD -> DWORD
# uFlag : GET_CONVERSION_LIST_FLAG -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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