ホーム › UI.Input.Ime › ImmGetConversionListA

ImmGetConversionListA

関数

文字列に対する変換候補の一覧を取得する(ANSI版)。

DLLIMM32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

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

パラメーター

名前

型

方向

説明

param0

HKL

対象IMEのキーボードレイアウトハンドル(HKL)。

param1

HIMC

対象の入力コンテキストハンドル(HIMC)。NULL指定も可能。

lpSrc

LPCSTR

リストのソースを指定する、null で終わる文字列へのポインターです。

lpDst

CANDIDATELIST*

out

関数がリストを取得する CANDIDATELIST 構造体へのポインターです。

dwBufLen

DWORD

出力バッファーのサイズ (バイト単位) です。完全な変換結果リストに必要なバッファーサイズを関数に返させる場合、アプリケーションはこのパラメーターを 0 に設定します。

uFlag

GET_CONVERSION_LIST_FLAG

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

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

戻り値の型: DWORD

公式ドキュメント

ImmGetConversionListA (ANSI) 関数 (immdev.h) は、IME 関連のメッセージを生成せずに、文字または単語の変換結果リストを取得します。

戻り値

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

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 ImmGetConversionListA(
    HKL param0,
    HIMC param1,
    LPCSTR lpSrc,
    CANDIDATELIST* lpDst,
    DWORD dwBufLen,
    GET_CONVERSION_LIST_FLAG uFlag
);

[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ImmGetConversionListA(
    IntPtr param0,   // HKL
    IntPtr param1,   // HIMC
    [MarshalAs(UnmanagedType.LPStr)] string lpSrc,   // LPCSTR
    IntPtr lpDst,   // CANDIDATELIST* out
    uint dwBufLen,   // DWORD
    uint uFlag   // GET_CONVERSION_LIST_FLAG
);

<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmGetConversionListA(
    param0 As IntPtr,   ' HKL
    param1 As IntPtr,   ' HIMC
    <MarshalAs(UnmanagedType.LPStr)> lpSrc As String,   ' LPCSTR
    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 : LPCSTR
' lpDst : CANDIDATELIST* out
' dwBufLen : DWORD
' uFlag : GET_CONVERSION_LIST_FLAG
Declare PtrSafe Function ImmGetConversionListA Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As LongPtr, _
    ByVal lpSrc As String, _
    ByVal lpDst As LongPtr, _
    ByVal dwBufLen As Long, _
    ByVal uFlag As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ImmGetConversionListA = ctypes.windll.imm32.ImmGetConversionListA
ImmGetConversionListA.restype = wintypes.DWORD
ImmGetConversionListA.argtypes = [
    wintypes.HANDLE,  # param0 : HKL
    wintypes.HANDLE,  # param1 : HIMC
    wintypes.LPCSTR,  # lpSrc : LPCSTR
    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')
ImmGetConversionListA = Fiddle::Function.new(
  lib['ImmGetConversionListA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HKL
    Fiddle::TYPE_VOIDP,  # param1 : HIMC
    Fiddle::TYPE_VOIDP,  # lpSrc : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpDst : CANDIDATELIST* out
    -Fiddle::TYPE_INT,  # dwBufLen : DWORD
    -Fiddle::TYPE_INT,  # uFlag : GET_CONVERSION_LIST_FLAG
  ],
  -Fiddle::TYPE_INT)

#[link(name = "imm32")]
extern "system" {
    fn ImmGetConversionListA(
        param0: *mut core::ffi::c_void,  // HKL
        param1: *mut core::ffi::c_void,  // HIMC
        lpSrc: *const u8,  // LPCSTR
        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.Ansi)]
public static extern uint ImmGetConversionListA(IntPtr param0, IntPtr param1, [MarshalAs(UnmanagedType.LPStr)] string lpSrc, IntPtr lpDst, uint dwBufLen, uint uFlag);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetConversionListA' -Namespace Win32 -PassThru
# $api::ImmGetConversionListA(param0, param1, lpSrc, lpDst, dwBufLen, uFlag)

#uselib "IMM32.dll"
#func global ImmGetConversionListA "ImmGetConversionListA" sptr, sptr, sptr, sptr, sptr, sptr
; ImmGetConversionListA param0, param1, lpSrc, varptr(lpDst), dwBufLen, uFlag   ; 戻り値は stat
; param0 : HKL -> "sptr"
; param1 : HIMC -> "sptr"
; lpSrc : LPCSTR -> "sptr"
; lpDst : CANDIDATELIST* out -> "sptr"
; dwBufLen : DWORD -> "sptr"
; uFlag : GET_CONVERSION_LIST_FLAG -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IMM32.dll"
#cfunc global ImmGetConversionListA "ImmGetConversionListA" sptr, sptr, str, var, int, int
; res = ImmGetConversionListA(param0, param1, lpSrc, lpDst, dwBufLen, uFlag)
; param0 : HKL -> "sptr"
; param1 : HIMC -> "sptr"
; lpSrc : LPCSTR -> "str"
; lpDst : CANDIDATELIST* out -> "var"
; dwBufLen : DWORD -> "int"
; uFlag : GET_CONVERSION_LIST_FLAG -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IMM32.dll"
#cfunc global ImmGetConversionListA "ImmGetConversionListA" sptr, sptr, str, sptr, int, int
; res = ImmGetConversionListA(param0, param1, lpSrc, varptr(lpDst), dwBufLen, uFlag)
; param0 : HKL -> "sptr"
; param1 : HIMC -> "sptr"
; lpSrc : LPCSTR -> "str"
; lpDst : CANDIDATELIST* out -> "sptr"
; dwBufLen : DWORD -> "int"
; uFlag : GET_CONVERSION_LIST_FLAG -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。