Win32 API 日本語リファレンス
ホームUI.Input.Ime › ImmGetCandidateListCountW

ImmGetCandidateListCountW

関数
候補リストの数とサイズを取得する(Unicode版)。
DLLIMM32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// IMM32.dll  (Unicode / -W)
#include <windows.h>

DWORD ImmGetCandidateListCountW(
    HIMC param0,
    DWORD* lpdwListCount
);

パラメーター

名前方向説明
param0HIMCin対象の入力コンテキストハンドル(HIMC)。
lpdwListCountDWORD*out候補リストのサイズを取得するためのバッファーへのポインター。

戻り値の型: DWORD

公式ドキュメント

ImmGetCandidateListCountW (Unicode) 関数 (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  (Unicode / -W)
#include <windows.h>

DWORD ImmGetCandidateListCountW(
    HIMC param0,
    DWORD* lpdwListCount
);
[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint ImmGetCandidateListCountW(
    IntPtr param0,   // HIMC
    out uint lpdwListCount   // DWORD* out
);
<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmGetCandidateListCountW(
    param0 As IntPtr,   ' HIMC
    <Out> ByRef lpdwListCount As UInteger   ' DWORD* out
) As UInteger
End Function
' param0 : HIMC
' lpdwListCount : DWORD* out
Declare PtrSafe Function ImmGetCandidateListCountW Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByRef lpdwListCount As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImmGetCandidateListCountW = ctypes.windll.imm32.ImmGetCandidateListCountW
ImmGetCandidateListCountW.restype = wintypes.DWORD
ImmGetCandidateListCountW.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    ctypes.POINTER(wintypes.DWORD),  # lpdwListCount : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetCandidateListCountW = Fiddle::Function.new(
  lib['ImmGetCandidateListCountW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    Fiddle::TYPE_VOIDP,  # lpdwListCount : DWORD* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "imm32")]
extern "system" {
    fn ImmGetCandidateListCountW(
        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.Unicode)]
public static extern uint ImmGetCandidateListCountW(IntPtr param0, out uint lpdwListCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetCandidateListCountW' -Namespace Win32 -PassThru
# $api::ImmGetCandidateListCountW(param0, lpdwListCount)
#uselib "IMM32.dll"
#func global ImmGetCandidateListCountW "ImmGetCandidateListCountW" wptr, wptr
; ImmGetCandidateListCountW param0, varptr(lpdwListCount)   ; 戻り値は stat
; param0 : HIMC -> "wptr"
; lpdwListCount : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IMM32.dll"
#cfunc global ImmGetCandidateListCountW "ImmGetCandidateListCountW" sptr, var
; res = ImmGetCandidateListCountW(param0, lpdwListCount)
; param0 : HIMC -> "sptr"
; lpdwListCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD ImmGetCandidateListCountW(HIMC param0, DWORD* lpdwListCount)
#uselib "IMM32.dll"
#cfunc global ImmGetCandidateListCountW "ImmGetCandidateListCountW" intptr, var
; res = ImmGetCandidateListCountW(param0, lpdwListCount)
; param0 : HIMC -> "intptr"
; lpdwListCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmGetCandidateListCountW = imm32.NewProc("ImmGetCandidateListCountW")
)

// param0 (HIMC), lpdwListCount (DWORD* out)
r1, _, err := procImmGetCandidateListCountW.Call(
	uintptr(param0),
	uintptr(lpdwListCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ImmGetCandidateListCountW(
  param0: THandle;   // HIMC
  lpdwListCount: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmGetCandidateListCountW';
result := DllCall("IMM32\ImmGetCandidateListCountW"
    , "Ptr", param0   ; HIMC
    , "Ptr", lpdwListCount   ; DWORD* out
    , "UInt")   ; return: DWORD
●ImmGetCandidateListCountW(param0, lpdwListCount) = DLL("IMM32.dll", "dword ImmGetCandidateListCountW(void*, void*)")
# 呼び出し: ImmGetCandidateListCountW(param0, lpdwListCount)
# param0 : HIMC -> "void*"
# lpdwListCount : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "imm32" fn ImmGetCandidateListCountW(
    param0: ?*anyopaque, // HIMC
    lpdwListCount: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ImmGetCandidateListCountW(
    param0: pointer,  # HIMC
    lpdwListCount: ptr uint32  # DWORD* out
): uint32 {.importc: "ImmGetCandidateListCountW", stdcall, dynlib: "IMM32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "imm32");
extern(Windows)
uint ImmGetCandidateListCountW(
    void* param0,   // HIMC
    uint* lpdwListCount   // DWORD* out
);
ccall((:ImmGetCandidateListCountW, "IMM32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt32}),
      param0, lpdwListCount)
# param0 : HIMC -> Ptr{Cvoid}
# lpdwListCount : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ImmGetCandidateListCountW(
    void* param0,
    uint32_t* lpdwListCount);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmGetCandidateListCountW(param0, lpdwListCount)
-- param0 : HIMC
-- lpdwListCount : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmGetCandidateListCountW = lib.func('__stdcall', 'ImmGetCandidateListCountW', 'uint32_t', ['void *', 'uint32_t *']);
// ImmGetCandidateListCountW(param0, lpdwListCount)
// param0 : HIMC -> 'void *'
// lpdwListCount : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmGetCandidateListCountW: { parameters: ["pointer", "pointer"], result: "u32" },
});
// lib.symbols.ImmGetCandidateListCountW(param0, lpdwListCount)
// param0 : HIMC -> "pointer"
// lpdwListCount : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ImmGetCandidateListCountW(
    void* param0,
    uint32_t* lpdwListCount);
C, "IMM32.dll");
// $ffi->ImmGetCandidateListCountW(param0, lpdwListCount);
// param0 : HIMC
// lpdwListCount : DWORD* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Imm32 extends StdCallLibrary {
    Imm32 INSTANCE = Native.load("imm32", Imm32.class, W32APIOptions.UNICODE_OPTIONS);
    int ImmGetCandidateListCountW(
        Pointer param0,   // HIMC
        IntByReference lpdwListCount   // DWORD* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("imm32")]
lib LibIMM32
  fun ImmGetCandidateListCountW = ImmGetCandidateListCountW(
    param0 : Void*,   # HIMC
    lpdwListCount : UInt32*   # DWORD* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ImmGetCandidateListCountWNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>);
typedef ImmGetCandidateListCountWDart = int Function(Pointer<Void>, Pointer<Uint32>);
final ImmGetCandidateListCountW = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmGetCandidateListCountWNative, ImmGetCandidateListCountWDart>('ImmGetCandidateListCountW');
// param0 : HIMC -> Pointer<Void>
// lpdwListCount : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmGetCandidateListCountW(
  param0: THandle;   // HIMC
  lpdwListCount: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmGetCandidateListCountW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmGetCandidateListCountW"
  c_ImmGetCandidateListCountW :: Ptr () -> Ptr Word32 -> IO Word32
-- param0 : HIMC -> Ptr ()
-- lpdwListCount : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immgetcandidatelistcountw =
  foreign "ImmGetCandidateListCountW"
    ((ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* param0 : HIMC -> (ptr void) *)
(* lpdwListCount : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

(cffi:defcfun ("ImmGetCandidateListCountW" imm-get-candidate-list-count-w :convention :stdcall) :uint32
  (param0 :pointer)   ; HIMC
  (lpdw-list-count :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmGetCandidateListCountW = Win32::API::More->new('IMM32',
    'DWORD ImmGetCandidateListCountW(HANDLE param0, LPVOID lpdwListCount)');
# my $ret = $ImmGetCandidateListCountW->Call($param0, $lpdwListCount);
# param0 : HIMC -> HANDLE
# lpdwListCount : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い