ImmGetDescriptionW 関数 (imm.h)
指定したバッファーに IME の説明をコピーします。
構文
UINT ImmGetDescriptionW(
HKL unnamedParam1,
[out, optional] LPWSTR lpszDescription,
[in] UINT uBufLen
);
パラメーター
unnamedParam1
[out, optional] lpszDescription
関数が IME を記述する null で終わる文字列を取得するバッファーへのポインター。
[in] uBufLen
出力バッファーのサイズ (文字単位)。 完全な説明に必要なバッファー サイズを関数が返す場合、アプリケーションはこのパラメーターを 0 に設定します (終端の null 文字は除きます)。
Windows NT、Windows 2000、Windows XP: バッファーのサイズは Unicode 文字で、それぞれ 2 バイトで構成されます。 パラメーターが 0 に設定されている場合、この関数は Unicode で終わる null 文字を除き、Unicode 文字で必要なバッファーのサイズを返します。
戻り値
出力バッファーにコピーされた文字数を返します。 アプリケーションで uBufLen パラメーターを 0 に設定すると、この関数は説明を受け取るために必要なバッファーのサイズを返します。 どちらの値にも、終端の null 文字は含まれます。 Unicode の場合、この関数は Unicode 終端の null 文字を含まない Unicode 文字の数を返します。
備考
手記
imm.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして ImmGetDescription を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows XP [デスクトップ アプリのみ]、東アジア言語のサポートがインストールされています。東アジア言語のサポートがインストールされています。 |
| サポートされる最小サーバー | Windows Server 2003 [デスクトップ アプリのみ] |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | imm.h (Immdev.h、Windows.h を含む) |
| ライブラリ | Imm32.lib |
| DLL | Imm32.dll |