ホーム › UI.Input.Ime › ImmGetCandidateWindow

ImmGetCandidateWindow

関数

候補ウィンドウの位置情報を取得する。

DLLIMM32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// IMM32.dll
#include <windows.h>

BOOL ImmGetCandidateWindow(
    HIMC param0,
    DWORD param1,
    CANDIDATEFORM* lpCandidate
);

パラメーター

名前	型	方向	説明
param0	HIMC	in	対象の入力コンテキストハンドル(HIMC)。
param1	DWORD	in	取得する候補ウィンドウのインデックス(0起点)。
lpCandidate	CANDIDATEFORM*	out	候補ウィンドウに関する情報をこの関数が取得する CANDIDATEFORM 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

ImmGetCandidateWindow 関数 (immdev.h) は、候補ウィンドウに関する情報を取得します。

戻り値

成功した場合は 0 以外の値を、それ以外の場合は 0 を返します。

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

各言語での呼び出し定義

// IMM32.dll
#include <windows.h>

BOOL ImmGetCandidateWindow(
    HIMC param0,
    DWORD param1,
    CANDIDATEFORM* lpCandidate
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", ExactSpelling = true)]
static extern bool ImmGetCandidateWindow(
    IntPtr param0,   // HIMC
    uint param1,   // DWORD
    IntPtr lpCandidate   // CANDIDATEFORM* out
);

<DllImport("IMM32.dll", ExactSpelling:=True)>
Public Shared Function ImmGetCandidateWindow(
    param0 As IntPtr,   ' HIMC
    param1 As UInteger,   ' DWORD
    lpCandidate As IntPtr   ' CANDIDATEFORM* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

ImmGetCandidateWindow = ctypes.windll.imm32.ImmGetCandidateWindow
ImmGetCandidateWindow.restype = wintypes.BOOL
ImmGetCandidateWindow.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    wintypes.DWORD,  # param1 : DWORD
    ctypes.c_void_p,  # lpCandidate : CANDIDATEFORM* out
]

require 'fiddle'
require 'fiddle/import'

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

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll")]
public static extern bool ImmGetCandidateWindow(IntPtr param0, uint param1, IntPtr lpCandidate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetCandidateWindow' -Namespace Win32 -PassThru
# $api::ImmGetCandidateWindow(param0, param1, lpCandidate)

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

出力引数:

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