ホーム › UI.Input.Ime › ImmGetCandidateListCountA

ImmGetCandidateListCountA

関数

候補リストの数とサイズを取得する(ANSI版)。

DLLIMM32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// IMM32.dll  (ANSI / -A)
#include <windows.h>

DWORD ImmGetCandidateListCountA(
    HIMC param0,
    DWORD* lpdwListCount
);

パラメーター

名前	型	方向	説明
param0	HIMC	in	対象の入力コンテキストハンドル(HIMC)。
lpdwListCount	DWORD*	out	この関数が候補リストのサイズを取得して格納するバッファーへのポインター。

戻り値の型: DWORD

公式ドキュメント

ImmGetCandidateListCountA (ANSI) 関数 (immdev.h) は、候補リストのサイズを取得します。

戻り値

成功した場合はすべての候補リストに必要なバイト数を返し、それ以外の場合は 0 を返します。

解説(Remarks)

アプリケーションは通常、IMN_OPENCANDIDATE または IMN_CHANGECANDIDATE コマンドに応答してこの関数を呼び出します。

メモ

immdev.h ヘッダーは ImmGetCandidateListCount をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させて使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// IMM32.dll  (ANSI / -A)
#include <windows.h>

DWORD ImmGetCandidateListCountA(
    HIMC param0,
    DWORD* lpdwListCount
);

[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ImmGetCandidateListCountA(
    IntPtr param0,   // HIMC
    out uint lpdwListCount   // DWORD* out
);

<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmGetCandidateListCountA(
    param0 As IntPtr,   ' HIMC
    <Out> ByRef lpdwListCount As UInteger   ' DWORD* out
) As UInteger
End Function

' param0 : HIMC
' lpdwListCount : DWORD* out
Declare PtrSafe Function ImmGetCandidateListCountA Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByRef lpdwListCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ImmGetCandidateListCountA = ctypes.windll.imm32.ImmGetCandidateListCountA
ImmGetCandidateListCountA.restype = wintypes.DWORD
ImmGetCandidateListCountA.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    ctypes.POINTER(wintypes.DWORD),  # lpdwListCount : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetCandidateListCountA = Fiddle::Function.new(
  lib['ImmGetCandidateListCountA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    Fiddle::TYPE_VOIDP,  # lpdwListCount : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "imm32")]
extern "system" {
    fn ImmGetCandidateListCountA(
        param0: *mut core::ffi::c_void,  // HIMC
        lpdwListCount: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Ansi)]
public static extern uint ImmGetCandidateListCountA(IntPtr param0, out uint lpdwListCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetCandidateListCountA' -Namespace Win32 -PassThru
# $api::ImmGetCandidateListCountA(param0, lpdwListCount)

#uselib "IMM32.dll"
#func global ImmGetCandidateListCountA "ImmGetCandidateListCountA" sptr, sptr
; ImmGetCandidateListCountA param0, varptr(lpdwListCount)   ; 戻り値は stat
; param0 : HIMC -> "sptr"
; lpdwListCount : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IMM32.dll"
#cfunc global ImmGetCandidateListCountA "ImmGetCandidateListCountA" sptr, var
; res = ImmGetCandidateListCountA(param0, lpdwListCount)
; param0 : HIMC -> "sptr"
; lpdwListCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IMM32.dll"
#cfunc global ImmGetCandidateListCountA "ImmGetCandidateListCountA" sptr, sptr
; res = ImmGetCandidateListCountA(param0, varptr(lpdwListCount))
; param0 : HIMC -> "sptr"
; lpdwListCount : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。