ホーム › UI.Input.Ime › ImmGetCandidateListW

ImmGetCandidateListW

関数

指定した変換候補リストを取得する(Unicode版)。

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

シグネチャ

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

DWORD ImmGetCandidateListW(
    HIMC param0,
    DWORD deIndex,
    CANDIDATELIST* lpCandList,   // optional
    DWORD dwBufLen
);

パラメーター

名前	型	方向	説明
param0	HIMC	in	対象の入力コンテキストハンドル(HIMC)。
deIndex	DWORD	in	候補一覧の 0 から始まるインデックス。
lpCandList	CANDIDATELIST*	outoptional	関数が候補一覧を取得する CANDIDATELIST 構造体へのポインター。
dwBufLen	DWORD	in	候補一覧を受け取るバッファーのサイズ (バイト単位)。出力バッファーに必要なサイズのみを関数に返させる場合、アプリケーションはこのパラメーターに 0 を指定できます。

戻り値の型: DWORD

公式ドキュメント

ImmGetCandidateListW (Unicode) 関数 (immdev.h) は、候補一覧を取得します。

戻り値

成功した場合、候補一覧バッファーにコピーされたバイト数を返します。アプリケーションが dwBufLen パラメーターに 0 を指定した場合、関数は候補一覧バッファーに必要なサイズを返します。

成功しなかった場合、関数は 0 を返します。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 ImmGetCandidateListW(
    HIMC param0,
    DWORD deIndex,
    CANDIDATELIST* lpCandList,   // optional
    DWORD dwBufLen
);

[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint ImmGetCandidateListW(
    IntPtr param0,   // HIMC
    uint deIndex,   // DWORD
    IntPtr lpCandList,   // CANDIDATELIST* optional, out
    uint dwBufLen   // DWORD
);

<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmGetCandidateListW(
    param0 As IntPtr,   ' HIMC
    deIndex As UInteger,   ' DWORD
    lpCandList As IntPtr,   ' CANDIDATELIST* optional, out
    dwBufLen As UInteger   ' DWORD
) As UInteger
End Function

' param0 : HIMC
' deIndex : DWORD
' lpCandList : CANDIDATELIST* optional, out
' dwBufLen : DWORD
Declare PtrSafe Function ImmGetCandidateListW Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal deIndex As Long, _
    ByVal lpCandList As LongPtr, _
    ByVal dwBufLen 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

ImmGetCandidateListW = ctypes.windll.imm32.ImmGetCandidateListW
ImmGetCandidateListW.restype = wintypes.DWORD
ImmGetCandidateListW.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    wintypes.DWORD,  # deIndex : DWORD
    ctypes.c_void_p,  # lpCandList : CANDIDATELIST* optional, out
    wintypes.DWORD,  # dwBufLen : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetCandidateListW = Fiddle::Function.new(
  lib['ImmGetCandidateListW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    -Fiddle::TYPE_INT,  # deIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpCandList : CANDIDATELIST* optional, out
    -Fiddle::TYPE_INT,  # dwBufLen : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "imm32")]
extern "system" {
    fn ImmGetCandidateListW(
        param0: *mut core::ffi::c_void,  // HIMC
        deIndex: u32,  // DWORD
        lpCandList: *mut CANDIDATELIST,  // CANDIDATELIST* optional, out
        dwBufLen: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Unicode)]
public static extern uint ImmGetCandidateListW(IntPtr param0, uint deIndex, IntPtr lpCandList, uint dwBufLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetCandidateListW' -Namespace Win32 -PassThru
# $api::ImmGetCandidateListW(param0, deIndex, lpCandList, dwBufLen)

#uselib "IMM32.dll"
#func global ImmGetCandidateListW "ImmGetCandidateListW" wptr, wptr, wptr, wptr
; ImmGetCandidateListW param0, deIndex, varptr(lpCandList), dwBufLen   ; 戻り値は stat
; param0 : HIMC -> "wptr"
; deIndex : DWORD -> "wptr"
; lpCandList : CANDIDATELIST* optional, out -> "wptr"
; dwBufLen : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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