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

ImmGetCompositionStringW

関数
入力コンテキストの変換中文字列など合成情報を取得する(Unicode版)。
DLLIMM32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT ImmGetCompositionStringW(
    HIMC param0,
    IME_COMPOSITION_STRING param1,
    void* lpBuf,   // optional
    DWORD dwBufLen
);

パラメーター

名前方向説明
param0HIMCin対象の入力コンテキストハンドル(HIMC)。
param1IME_COMPOSITION_STRINGin取得する変換文字列情報の種類。GCS_COMPSTR/GCS_RESULTSTR等を指定する。
lpBufvoid*outoptionalコンポジション文字列情報を取得するバッファへのポインター。
dwBufLenDWORDin出力バッファのサイズ(バイト単位)。出力が Unicode 文字列であっても同様です。必要な出力バッファのサイズを関数に返させる場合、アプリケーションはこのパラメーターに 0 を設定します。

戻り値の型: INT

公式ドキュメント

ImmGetCompositionStringW(Unicode)関数(immdev.h)は、コンポジション文字列に関する情報を取得します。

戻り値

出力バッファにコピーされたバイト数を返します。dwBufLen に 0 が設定されている場合、この関数は、要求されたすべての情報を受け取るために必要なバッファサイズ(バイト単位)を返します。ただし終端の null 文字は含みません。要求されたデータが Unicode 文字列であっても、戻り値は常にバイト単位のサイズです。

成功しなかった場合、この関数は次のいずれかの負のエラーコードを返します。

解説(Remarks)

アプリケーションは、WM_IME_COMPOSITION メッセージまたは WM_IME_STARTCOMPOSITION メッセージに応答してこの関数を呼び出します。アプリケーションが ImmReleaseContext 関数を呼び出すと、IMM はその情報を削除します。

Note アプリケーションが Soft Input Panel(SIP)とともに使用される場合は、全角ひらがなと半角カタカナの両方を処理するコードを記述する必要があります。
メモ

immdev.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ImmGetCompositionString を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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>

INT ImmGetCompositionStringW(
    HIMC param0,
    IME_COMPOSITION_STRING param1,
    void* lpBuf,   // optional
    DWORD dwBufLen
);
[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int ImmGetCompositionStringW(
    IntPtr param0,   // HIMC
    uint param1,   // IME_COMPOSITION_STRING
    IntPtr lpBuf,   // void* optional, out
    uint dwBufLen   // DWORD
);
<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmGetCompositionStringW(
    param0 As IntPtr,   ' HIMC
    param1 As UInteger,   ' IME_COMPOSITION_STRING
    lpBuf As IntPtr,   ' void* optional, out
    dwBufLen As UInteger   ' DWORD
) As Integer
End Function
' param0 : HIMC
' param1 : IME_COMPOSITION_STRING
' lpBuf : void* optional, out
' dwBufLen : DWORD
Declare PtrSafe Function ImmGetCompositionStringW Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As Long, _
    ByVal lpBuf As LongPtr, _
    ByVal dwBufLen 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

ImmGetCompositionStringW = ctypes.windll.imm32.ImmGetCompositionStringW
ImmGetCompositionStringW.restype = ctypes.c_int
ImmGetCompositionStringW.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    wintypes.DWORD,  # param1 : IME_COMPOSITION_STRING
    ctypes.POINTER(None),  # lpBuf : void* optional, out
    wintypes.DWORD,  # dwBufLen : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetCompositionStringW = Fiddle::Function.new(
  lib['ImmGetCompositionStringW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    -Fiddle::TYPE_INT,  # param1 : IME_COMPOSITION_STRING
    Fiddle::TYPE_VOIDP,  # lpBuf : void* optional, out
    -Fiddle::TYPE_INT,  # dwBufLen : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "imm32")]
extern "system" {
    fn ImmGetCompositionStringW(
        param0: *mut core::ffi::c_void,  // HIMC
        param1: u32,  // IME_COMPOSITION_STRING
        lpBuf: *mut (),  // void* optional, out
        dwBufLen: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Unicode)]
public static extern int ImmGetCompositionStringW(IntPtr param0, uint param1, IntPtr lpBuf, uint dwBufLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetCompositionStringW' -Namespace Win32 -PassThru
# $api::ImmGetCompositionStringW(param0, param1, lpBuf, dwBufLen)
#uselib "IMM32.dll"
#func global ImmGetCompositionStringW "ImmGetCompositionStringW" wptr, wptr, wptr, wptr
; ImmGetCompositionStringW param0, param1, lpBuf, dwBufLen   ; 戻り値は stat
; param0 : HIMC -> "wptr"
; param1 : IME_COMPOSITION_STRING -> "wptr"
; lpBuf : void* optional, out -> "wptr"
; dwBufLen : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IMM32.dll"
#cfunc global ImmGetCompositionStringW "ImmGetCompositionStringW" sptr, int, sptr, int
; res = ImmGetCompositionStringW(param0, param1, lpBuf, dwBufLen)
; param0 : HIMC -> "sptr"
; param1 : IME_COMPOSITION_STRING -> "int"
; lpBuf : void* optional, out -> "sptr"
; dwBufLen : DWORD -> "int"
; INT ImmGetCompositionStringW(HIMC param0, IME_COMPOSITION_STRING param1, void* lpBuf, DWORD dwBufLen)
#uselib "IMM32.dll"
#cfunc global ImmGetCompositionStringW "ImmGetCompositionStringW" intptr, int, intptr, int
; res = ImmGetCompositionStringW(param0, param1, lpBuf, dwBufLen)
; param0 : HIMC -> "intptr"
; param1 : IME_COMPOSITION_STRING -> "int"
; lpBuf : void* optional, out -> "intptr"
; dwBufLen : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmGetCompositionStringW = imm32.NewProc("ImmGetCompositionStringW")
)

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

extern "imm32" fn ImmGetCompositionStringW(
    param0: ?*anyopaque, // HIMC
    param1: u32, // IME_COMPOSITION_STRING
    lpBuf: ?*anyopaque, // void* optional, out
    dwBufLen: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ImmGetCompositionStringW(
    param0: pointer,  # HIMC
    param1: uint32,  # IME_COMPOSITION_STRING
    lpBuf: pointer,  # void* optional, out
    dwBufLen: uint32  # DWORD
): int32 {.importc: "ImmGetCompositionStringW", stdcall, dynlib: "IMM32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "imm32");
extern(Windows)
int ImmGetCompositionStringW(
    void* param0,   // HIMC
    uint param1,   // IME_COMPOSITION_STRING
    void* lpBuf,   // void* optional, out
    uint dwBufLen   // DWORD
);
ccall((:ImmGetCompositionStringW, "IMM32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}, UInt32),
      param0, param1, lpBuf, dwBufLen)
# param0 : HIMC -> Ptr{Cvoid}
# param1 : IME_COMPOSITION_STRING -> UInt32
# lpBuf : void* optional, out -> Ptr{Cvoid}
# dwBufLen : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t ImmGetCompositionStringW(
    void* param0,
    uint32_t param1,
    void* lpBuf,
    uint32_t dwBufLen);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmGetCompositionStringW(param0, param1, lpBuf, dwBufLen)
-- param0 : HIMC
-- param1 : IME_COMPOSITION_STRING
-- lpBuf : void* optional, out
-- dwBufLen : DWORD
-- 構造体/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 ImmGetCompositionStringW = lib.func('__stdcall', 'ImmGetCompositionStringW', 'int32_t', ['void *', 'uint32_t', 'void *', 'uint32_t']);
// ImmGetCompositionStringW(param0, param1, lpBuf, dwBufLen)
// param0 : HIMC -> 'void *'
// param1 : IME_COMPOSITION_STRING -> 'uint32_t'
// lpBuf : void* optional, out -> 'void *'
// dwBufLen : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmGetCompositionStringW: { parameters: ["pointer", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.ImmGetCompositionStringW(param0, param1, lpBuf, dwBufLen)
// param0 : HIMC -> "pointer"
// param1 : IME_COMPOSITION_STRING -> "u32"
// lpBuf : void* optional, out -> "pointer"
// dwBufLen : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ImmGetCompositionStringW(
    void* param0,
    uint32_t param1,
    void* lpBuf,
    uint32_t dwBufLen);
C, "IMM32.dll");
// $ffi->ImmGetCompositionStringW(param0, param1, lpBuf, dwBufLen);
// param0 : HIMC
// param1 : IME_COMPOSITION_STRING
// lpBuf : void* optional, out
// dwBufLen : DWORD
// 構造体/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 ImmGetCompositionStringW(
        Pointer param0,   // HIMC
        int param1,   // IME_COMPOSITION_STRING
        Pointer lpBuf,   // void* optional, out
        int dwBufLen   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("imm32")]
lib LibIMM32
  fun ImmGetCompositionStringW = ImmGetCompositionStringW(
    param0 : Void*,   # HIMC
    param1 : UInt32,   # IME_COMPOSITION_STRING
    lpBuf : Void*,   # void* optional, out
    dwBufLen : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

foreign import stdcall safe "ImmGetCompositionStringW"
  c_ImmGetCompositionStringW :: Ptr () -> Word32 -> Ptr () -> Word32 -> IO Int32
-- param0 : HIMC -> Ptr ()
-- param1 : IME_COMPOSITION_STRING -> Word32
-- lpBuf : void* optional, out -> Ptr ()
-- dwBufLen : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

文字セット違い
公式の関連項目
使用する型