ImmGetCandidateListW

ImmGetCandidateListW (Unicode) 関数 (immdev.h) は、候補リストを取得する。

ImmGetCandidateListW param0, deIndex, lpCandList, dwBufLen

param0 : [intptr] 
deIndex : [int] 候補リストのゼロベースのインデックス。
lpCandList : [var] 関数が候補リストを取得する CANDIDATELIST 構造体へのポインタ。
dwBufLen : [int] 候補リストを受け取るバッファのサイズ (バイト単位)。出力バッファに必要なサイズだけを返させたい場合、アプリケーションはこのパラメータに 0 を指定してもよい。

(プラグイン / モジュール : imm32.dll)

解説

ImmGetCandidateListW (Unicode) 関数 (immdev.h) は、候補リストを取得する。

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

[備考]
> [!NOTE] > immdev.h ヘッダーは ImmGetCandidateList
をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に応じて ANSI 版または Unicode
版を自動的に選択する。エンコーディング非依存のエイリアスと、エンコーディング非依存でないコードを混在して使うと、コンパイルエラーや実行時エラーの原因になる可能性がある。詳細は
[Conventions for Function
Prototypes](/windows/win32/intl/conventions-for-function-prototypes)
を参照。

情報

プラグイン / モジュールimm32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の imm32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_imm32_gen2.hs