ImmGetDescriptionW

ImmGetDescriptionW (Unicode) 関数 (immdev.h) は、IME の説明を指定したバッファにコピーする。

ImmGetDescriptionW param0, lpszDescription, uBufLen

param0 : [intptr] 
lpszDescription : [wstr] 関数が IME を説明する null 終端文字列を取得するバッファへのポインタ。
uBufLen : [int] 出力バッファのサイズ (文字単位)。説明全体に必要なバッファサイズ (終端の null 文字を除く) を返させたい場合、アプリケーションはこのパラメータに 0 を指定する。Windows NT、Windows 2000、Windows XP: バッファのサイズは Unicode 文字単位で、各文字は 2 バイトで構成される。このパラメータを 0 に設定すると、関数は必要なバッファサイズを Unicode 文字単位で (Unicode の終端 null 文字を除いて) 返す。

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

解説

ImmGetDescriptionW (Unicode) 関数 (immdev.h) は、IME の説明を指定したバッファにコピーする。

[戻り値]
出力バッファにコピーされた文字数を返す。アプリケーションが uBufLen パラメータに 0
を指定した場合、説明を受け取るのに必要なバッファサイズを返す。いずれの値も終端の null 文字を含まない。Unicode
の場合は、Unicode 終端 null 文字を除く Unicode 文字数を返す。

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

情報