<Return[I]><Top>

ImmGetDescription

Declare Function Api_ImmGetDescription& Lib "imm32" Alias "ImmGetDescriptionA" (ByVal hKL&, ByVal lpszDescription$, ByVal uBufLen&)

Declare Function ImmGetDescription Lib "imm32" Alias "ImmGetDescriptionA" (ByVal hkl As Long, ByVal lpsz As String, ByVal uBufLen As Long) As Long

IME を説明する文字列を指定されたバッファにコピーする。

パラメータ
hKL
    入力ロケール識別子を指定する。
lpszDescription
    IME の説明文(NULL で終わる文字列)を受け取るバッファへのポインタを指定する。
uBufLen
    バッファのサイズを文字数で指定する。

    このパラメータに 0 を指定すると、説明文全体を受け取るために必要となるバッファサイズ( ただし最後の NULL 文字は含まない)が関

    数から返る。
    Windows NT/2000:バッファのサイズは、Unicode 文字の文字数となる(1 文字が 2 バイト)。

戻り値
    バッファにコピーされた文字の数が返る。

    uBufLen パラメータに 0 を指定した場合は、説明文を受け取るのに必要となるバッファサイズ( 文字数)が返る。

    どちらの場合も、最後の NULL 文字は含まれない。