ImmGetCandidateListA 関数 (imm.h)
候補リストを取得します。
構文
DWORD ImmGetCandidateListA(
HIMC unnamedParam1,
[in] DWORD deIndex,
[out, optional] LPCANDIDATELIST lpCandList,
[in] DWORD dwBufLen
);
パラメーター
unnamedParam1
[in] deIndex
候補リストの 0 から始まるインデックス。
[out, optional] lpCandList
関数が候補リストを取得する CANDIDATELIST 構造体へのポインター。
[in] dwBufLen
候補リストを受信するバッファーのサイズ (バイト単位)。 関数が出力バッファーの必要なサイズのみを返す場合、アプリケーションはこのパラメーターに 0 を指定できます。
戻り値
成功した場合に候補リスト バッファーにコピーされたバイト数を返します。 アプリケーションが dwBufLen パラメーターに 0 を指定した場合、この関数は候補リスト バッファーに必要なサイズを返します。
成功しなかった場合、関数は 0 を返します。
注釈
注意
imm.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして ImmGetCandidateList を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP [デスクトップ アプリのみ]、東アジア言語のサポートがインストールされています。 |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | imm.h (Immdev.h、Windows.h を含む) |
| Library | Imm32.lib |
| [DLL] | Imm32.dll |