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

ImmGetCompositionWindow

関数
変換ウィンドウの位置情報を取得する。
DLLIMM32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL ImmGetCompositionWindow(
    HIMC param0,
    COMPOSITIONFORM* lpCompForm
);

パラメーター

名前方向説明
param0HIMCin対象の入力コンテキストハンドル(HIMC)。
lpCompFormCOMPOSITIONFORM*outコンポジションウィンドウに関する情報を取得するための COMPOSITIONFORM 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

ImmGetCompositionWindow 関数 (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 ImmGetCompositionWindow(
    HIMC param0,
    COMPOSITIONFORM* lpCompForm
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", ExactSpelling = true)]
static extern bool ImmGetCompositionWindow(
    IntPtr param0,   // HIMC
    IntPtr lpCompForm   // COMPOSITIONFORM* out
);
<DllImport("IMM32.dll", ExactSpelling:=True)>
Public Shared Function ImmGetCompositionWindow(
    param0 As IntPtr,   ' HIMC
    lpCompForm As IntPtr   ' COMPOSITIONFORM* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' param0 : HIMC
' lpCompForm : COMPOSITIONFORM* out
Declare PtrSafe Function ImmGetCompositionWindow Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal lpCompForm As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImmGetCompositionWindow = ctypes.windll.imm32.ImmGetCompositionWindow
ImmGetCompositionWindow.restype = wintypes.BOOL
ImmGetCompositionWindow.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    ctypes.c_void_p,  # lpCompForm : COMPOSITIONFORM* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmGetCompositionWindow = imm32.NewProc("ImmGetCompositionWindow")
)

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

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

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

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

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

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

関連項目

使用する型