ImmGetCompositionString

Declare Function Api_ImmGetCompositionString& Lib "imm32" Alias "ImmGetCompositionStringA"(ByVal hIMC&, ByVal dwIndex&, ByVal lpBuf, ByVal dwBufLen&)

Declare Function ImmGetCompositionString Lib "imm32" Alias "ImmGetCompositionStringA" (ByVal himc As Long, ByVal dw As Long, lpv As Any, ByVal dw2 As Long) As Long

変換文字列に関する情報を取得する。

パラメータ
hIMC
    入力コンテキストのハンドルを指定する。
dwIndex
    取得する情報のインデックスを指定する。

    このパラメータには、「Input Method Editor Constants」の「IME Composition String Values」の表に示されている値のいずれかを指

    定できる。GCS_CURSORPOS と GCS_DELTASTART 以外の値を指定した場合は、要求した情報が指定したバッファにコピーされる。

    カーソル位置と変換開始位置（delta 値）は、戻り値の下位 16 ビットに格納される。
lpBuf
    要求した情報を受け取るバッファへのポインタを指定する。
dwBufLen
    バッファのサイズをバイト単位で指定する。

    このパラメータに 0 を指定すると、要求した情報をすべて受け取るために必要となるバッファサイズが関数から返る。
　

戻り値
    バッファにコピーしたデータのバイト数が返る。

    dwBufLen パラメータに 0 を指定した場合は、要求した情報をすべて受け取るために必要となるバッファサイズ（ バイト単位）が返る。

    エラーが発生すると、次のいずれかのエラー値が返る。

解説
    アプリケーションでは通常、WM_IME_COMPOSITION メッセージまたは WM_IME_STARTCOMPOSITION メッセージに応答してこの

    関数を呼び出す。この関数を使って取得できる情報は、ImmReleaseContext 関数を呼び出すと IMM により削除される。