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

ImmSetCandidateWindow

関数
候補ウィンドウの位置情報を設定する。
DLLIMM32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL ImmSetCandidateWindow(
    HIMC param0,
    CANDIDATEFORM* lpCandidate
);

パラメーター

名前方向説明
param0HIMCin対象の入力コンテキストハンドル(HIMC)。
lpCandidateCANDIDATEFORM*in候補ウィンドウに関する情報を格納した CANDIDATEFORM 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

解説(Remarks)

この関数は IMN_SETCANDIDATEPOS コマンドの送信を引き起こします。IME とアプリケーションの両方がこの関数を呼び出します。

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

各言語での呼び出し定義

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

BOOL ImmSetCandidateWindow(
    HIMC param0,
    CANDIDATEFORM* lpCandidate
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", ExactSpelling = true)]
static extern bool ImmSetCandidateWindow(
    IntPtr param0,   // HIMC
    IntPtr lpCandidate   // CANDIDATEFORM*
);
<DllImport("IMM32.dll", ExactSpelling:=True)>
Public Shared Function ImmSetCandidateWindow(
    param0 As IntPtr,   ' HIMC
    lpCandidate As IntPtr   ' CANDIDATEFORM*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' param0 : HIMC
' lpCandidate : CANDIDATEFORM*
Declare PtrSafe Function ImmSetCandidateWindow Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal lpCandidate As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImmSetCandidateWindow = ctypes.windll.imm32.ImmSetCandidateWindow
ImmSetCandidateWindow.restype = wintypes.BOOL
ImmSetCandidateWindow.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    ctypes.c_void_p,  # lpCandidate : CANDIDATEFORM*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmSetCandidateWindow = Fiddle::Function.new(
  lib['ImmSetCandidateWindow'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    Fiddle::TYPE_VOIDP,  # lpCandidate : CANDIDATEFORM*
  ],
  Fiddle::TYPE_INT)
#[link(name = "imm32")]
extern "system" {
    fn ImmSetCandidateWindow(
        param0: *mut core::ffi::c_void,  // HIMC
        lpCandidate: *mut CANDIDATEFORM  // CANDIDATEFORM*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll")]
public static extern bool ImmSetCandidateWindow(IntPtr param0, IntPtr lpCandidate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmSetCandidateWindow' -Namespace Win32 -PassThru
# $api::ImmSetCandidateWindow(param0, lpCandidate)
#uselib "IMM32.dll"
#func global ImmSetCandidateWindow "ImmSetCandidateWindow" sptr, sptr
; ImmSetCandidateWindow param0, varptr(lpCandidate)   ; 戻り値は stat
; param0 : HIMC -> "sptr"
; lpCandidate : CANDIDATEFORM* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IMM32.dll"
#cfunc global ImmSetCandidateWindow "ImmSetCandidateWindow" sptr, var
; res = ImmSetCandidateWindow(param0, lpCandidate)
; param0 : HIMC -> "sptr"
; lpCandidate : CANDIDATEFORM* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ImmSetCandidateWindow(HIMC param0, CANDIDATEFORM* lpCandidate)
#uselib "IMM32.dll"
#cfunc global ImmSetCandidateWindow "ImmSetCandidateWindow" intptr, var
; res = ImmSetCandidateWindow(param0, lpCandidate)
; param0 : HIMC -> "intptr"
; lpCandidate : CANDIDATEFORM* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmSetCandidateWindow = imm32.NewProc("ImmSetCandidateWindow")
)

// param0 (HIMC), lpCandidate (CANDIDATEFORM*)
r1, _, err := procImmSetCandidateWindow.Call(
	uintptr(param0),
	uintptr(lpCandidate),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ImmSetCandidateWindow(
  param0: THandle;   // HIMC
  lpCandidate: Pointer   // CANDIDATEFORM*
): BOOL; stdcall;
  external 'IMM32.dll' name 'ImmSetCandidateWindow';
result := DllCall("IMM32\ImmSetCandidateWindow"
    , "Ptr", param0   ; HIMC
    , "Ptr", lpCandidate   ; CANDIDATEFORM*
    , "Int")   ; return: BOOL
●ImmSetCandidateWindow(param0, lpCandidate) = DLL("IMM32.dll", "bool ImmSetCandidateWindow(void*, void*)")
# 呼び出し: ImmSetCandidateWindow(param0, lpCandidate)
# param0 : HIMC -> "void*"
# lpCandidate : CANDIDATEFORM* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "imm32" fn ImmSetCandidateWindow(
    param0: ?*anyopaque, // HIMC
    lpCandidate: [*c]CANDIDATEFORM // CANDIDATEFORM*
) callconv(std.os.windows.WINAPI) i32;
proc ImmSetCandidateWindow(
    param0: pointer,  # HIMC
    lpCandidate: ptr CANDIDATEFORM  # CANDIDATEFORM*
): int32 {.importc: "ImmSetCandidateWindow", stdcall, dynlib: "IMM32.dll".}
pragma(lib, "imm32");
extern(Windows)
int ImmSetCandidateWindow(
    void* param0,   // HIMC
    CANDIDATEFORM* lpCandidate   // CANDIDATEFORM*
);
ccall((:ImmSetCandidateWindow, "IMM32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{CANDIDATEFORM}),
      param0, lpCandidate)
# param0 : HIMC -> Ptr{Cvoid}
# lpCandidate : CANDIDATEFORM* -> Ptr{CANDIDATEFORM}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ImmSetCandidateWindow(
    void* param0,
    void* lpCandidate);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmSetCandidateWindow(param0, lpCandidate)
-- param0 : HIMC
-- lpCandidate : CANDIDATEFORM*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmSetCandidateWindow = lib.func('__stdcall', 'ImmSetCandidateWindow', 'int32_t', ['void *', 'void *']);
// ImmSetCandidateWindow(param0, lpCandidate)
// param0 : HIMC -> 'void *'
// lpCandidate : CANDIDATEFORM* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmSetCandidateWindow: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.ImmSetCandidateWindow(param0, lpCandidate)
// param0 : HIMC -> "pointer"
// lpCandidate : CANDIDATEFORM* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ImmSetCandidateWindow(
    void* param0,
    void* lpCandidate);
C, "IMM32.dll");
// $ffi->ImmSetCandidateWindow(param0, lpCandidate);
// param0 : HIMC
// lpCandidate : CANDIDATEFORM*
// 構造体/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);
    boolean ImmSetCandidateWindow(
        Pointer param0,   // HIMC
        Pointer lpCandidate   // CANDIDATEFORM*
    );
}
@[Link("imm32")]
lib LibIMM32
  fun ImmSetCandidateWindow = ImmSetCandidateWindow(
    param0 : Void*,   # HIMC
    lpCandidate : CANDIDATEFORM*   # CANDIDATEFORM*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("ImmSetCandidateWindow" imm-set-candidate-window :convention :stdcall) :int32
  (param0 :pointer)   ; HIMC
  (lp-candidate :pointer))   ; CANDIDATEFORM*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmSetCandidateWindow = Win32::API::More->new('IMM32',
    'BOOL ImmSetCandidateWindow(HANDLE param0, LPVOID lpCandidate)');
# my $ret = $ImmSetCandidateWindow->Call($param0, $lpCandidate);
# param0 : HIMC -> HANDLE
# lpCandidate : CANDIDATEFORM* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型