ImmGetCandidateListCount

機能

候補リストのサイズを取得する

Declare Function ImmGetCandidateList Lib "imm32.dll" Alias "ImmGetCandidateListCountA" _

        (ByVal hIMC As Long, lpdwListCount As Long) As Long

Declare Function ImmGetCandidateList Lib "imm32.dll" Alias "ImmGetCandidateListCountA" _

        (ByVal hIMC As Integer, lpdwListCount As Integer) As Integer

DWORD ImeGetCandidateListCount（
HIMC hIMC,
LPDWORD lpdwListCount
);
引数
hIMC

入力コンテキストのハンドル(ImmGetContext()関数の戻り値)

lpdwListCount

(戻り値)候補リストが表示されているとき    1
         表示されていないとき                      0

戻り値

正常終了のとき、全ての候補リストをコピーするために必要なバイト数

(CANDIDATELIST構造体と候補単語の文字列を含む)

備考

この関数は通常、IMN_PENCANDIDATEまたはIMN_CHANGECANDIDATEに反応して実行される。

つまり候補リストが開いたときに使う。

「候補リスト」とは入力された読みに対して変換候補をリストアップするウィンドウに表示する

リストのこと。SDKではlpdwListCountの解説は「候補リストのサイズ」となっているが

実際にはサイズが戻るのではなく、この関数を呼び出した時点において

候補リストが表示されているかどうかを返す。