ホーム › UI.Input.Ime › ImmGetProperty
ImmGetProperty
関数指定IMEのプロパティや機能情報を取得する。
シグネチャ
// IMM32.dll
#include <windows.h>
DWORD ImmGetProperty(
HKL param0,
DWORD param1
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| param0 | HKL | in | プロパティを取得する対象IMEのキーボードレイアウトハンドル(HKL)。 |
| param1 | DWORD | in | 取得するプロパティの種類を示すインデックス。IGP_PROPERTYやIGP_CONVERSION等を指定する。 |
戻り値の型: DWORD
公式ドキュメント
ImmGetProperty 関数 (immdev.h) は、指定された入力ロケールに関連付けられた IME のプロパティと機能を取得します。
戻り値
dwIndex パラメーターの値に応じて、プロパティ値または機能値を返します。dwIndex に IGP_PROPERTY を指定した場合、この関数は次の値の 1 つ以上を返します。
| 値 | 意味 |
|---|---|
| IME_PROP_AT_CARET | 設定されている場合、変換ウィンドウはキャレット位置に表示されます。クリアされている場合、ウィンドウはキャレット位置の近くに表示されます。 |
| IME_PROP_SPECIAL_UI | 設定されている場合、IME は非標準のユーザーインターフェイスを備えています。アプリケーションは IME ウィンドウ内に描画しないでください。 |
| IME_PROP_CANDLIST_START_FROM_1 | 設定されている場合、候補リスト内の文字列は 1 から番号付けされます。クリアされている場合、文字列は 0 から始まります。 |
| IME_PROP_UNICODE | 設定されている場合、IME は Unicode IME と見なされます。オペレーティングシステムと IME は Unicode IME インターフェイスを介して通信します。クリアされている場合、IME は ANSI インターフェイスを使用してオペレーティングシステムと通信します。 |
| IME_PROP_COMPLETE_ON_UNSELECT | 設定されている場合、IME が非アクティブ化されると IME はコンポジション文字列を確定します。クリアされている場合、IME が非アクティブ化されると (たとえばキーボードレイアウトの変更時)、IME はコンポジション文字列をキャンセルします。 |
| IME_PROP_ACCEPT_WIDE_VKEY | 設定されている場合、IME は SendInput 関数から VK_PACKET を使用して送り込まれた Unicode を処理します。クリアされている場合、IME は送り込まれた Unicode を処理せず、送り込まれた Unicode をアプリケーションに直接送信することがあります。 |
dwIndex に IGP_UI を指定した場合、この関数は次の値の 1 つ以上を返します。
| 値 | 意味 |
|---|---|
| UI_CAP_2700 | 0 または 2700 のテキストエスケープメント値をサポートします。詳細については、LOGFONT 構造体の lfEscapement メンバーを参照してください。 |
| UI_CAP_ROT90 | 0、900、1800、または 2700 のテキストエスケープメント値をサポートします。詳細については、lfEscapement を参照してください。 |
| UI_CAP_ROTANY | 任意のテキストエスケープメント値をサポートします。詳細については、lfEscapement を参照してください。 |
dwIndex に IGP_SETCOMPSTR を指定した場合、この関数は次の値の 1 つ以上を返します。
| 値 | 意味 |
|---|---|
| SCS_CAP_COMPSTR | ImmSetCompositionString 関数を SCS_SETSTR 値とともに呼び出してコンポジション文字列を作成します。 |
| SCS_CAP_MAKEREAD | ImmSetCompositionString 関数を SCS_SETSTR とともに使用し、lpRead を設定しない場合に、対応するコンポジション文字列から読み文字列を作成します。 |
| SCS_CAP_SETRECONVERTSTRING: | この IME は再変換をサポートできます。再変換を行うには ImmSetCompositionString を使用します。 |
dwIndex に IGP_SELECT を指定した場合、この関数は次の値の 1 つ以上を返します。
| 値 | 意味 |
|---|---|
| SELECT_CAP_CONVMODE | 新しい IME が選択されたときに変換モードを継承します。 |
| SELECT_CAP_SENTENCE | 新しい IME が選択されたときに文単位モードを継承します。 |
dwIndex に IGP_GETIMEVERSION を指定した場合、この関数は次の値の 1 つ以上を返します。
| 値 | 意味 |
|---|---|
| IMEVER_0310 | IME は Windows 3.1 用に作成されました。 |
| IMEVER_0400 | IME は Windows Me/98/95 用に作成されました。 |
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IMM32.dll
#include <windows.h>
DWORD ImmGetProperty(
HKL param0,
DWORD param1
);[DllImport("IMM32.dll", ExactSpelling = true)]
static extern uint ImmGetProperty(
IntPtr param0, // HKL
uint param1 // DWORD
);<DllImport("IMM32.dll", ExactSpelling:=True)>
Public Shared Function ImmGetProperty(
param0 As IntPtr, ' HKL
param1 As UInteger ' DWORD
) As UInteger
End Function' param0 : HKL
' param1 : DWORD
Declare PtrSafe Function ImmGetProperty Lib "imm32" ( _
ByVal param0 As LongPtr, _
ByVal param1 As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ImmGetProperty = ctypes.windll.imm32.ImmGetProperty
ImmGetProperty.restype = wintypes.DWORD
ImmGetProperty.argtypes = [
wintypes.HANDLE, # param0 : HKL
wintypes.DWORD, # param1 : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IMM32.dll')
ImmGetProperty = Fiddle::Function.new(
lib['ImmGetProperty'],
[
Fiddle::TYPE_VOIDP, # param0 : HKL
-Fiddle::TYPE_INT, # param1 : DWORD
],
-Fiddle::TYPE_INT)#[link(name = "imm32")]
extern "system" {
fn ImmGetProperty(
param0: *mut core::ffi::c_void, // HKL
param1: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IMM32.dll")]
public static extern uint ImmGetProperty(IntPtr param0, uint param1);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetProperty' -Namespace Win32 -PassThru
# $api::ImmGetProperty(param0, param1)#uselib "IMM32.dll"
#func global ImmGetProperty "ImmGetProperty" sptr, sptr
; ImmGetProperty param0, param1 ; 戻り値は stat
; param0 : HKL -> "sptr"
; param1 : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IMM32.dll"
#cfunc global ImmGetProperty "ImmGetProperty" sptr, int
; res = ImmGetProperty(param0, param1)
; param0 : HKL -> "sptr"
; param1 : DWORD -> "int"; DWORD ImmGetProperty(HKL param0, DWORD param1)
#uselib "IMM32.dll"
#cfunc global ImmGetProperty "ImmGetProperty" intptr, int
; res = ImmGetProperty(param0, param1)
; param0 : HKL -> "intptr"
; param1 : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
imm32 = windows.NewLazySystemDLL("IMM32.dll")
procImmGetProperty = imm32.NewProc("ImmGetProperty")
)
// param0 (HKL), param1 (DWORD)
r1, _, err := procImmGetProperty.Call(
uintptr(param0),
uintptr(param1),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction ImmGetProperty(
param0: THandle; // HKL
param1: DWORD // DWORD
): DWORD; stdcall;
external 'IMM32.dll' name 'ImmGetProperty';result := DllCall("IMM32\ImmGetProperty"
, "Ptr", param0 ; HKL
, "UInt", param1 ; DWORD
, "UInt") ; return: DWORD●ImmGetProperty(param0, param1) = DLL("IMM32.dll", "dword ImmGetProperty(void*, dword)")
# 呼び出し: ImmGetProperty(param0, param1)
# param0 : HKL -> "void*"
# param1 : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "imm32" fn ImmGetProperty(
param0: ?*anyopaque, // HKL
param1: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc ImmGetProperty(
param0: pointer, # HKL
param1: uint32 # DWORD
): uint32 {.importc: "ImmGetProperty", stdcall, dynlib: "IMM32.dll".}pragma(lib, "imm32");
extern(Windows)
uint ImmGetProperty(
void* param0, // HKL
uint param1 // DWORD
);ccall((:ImmGetProperty, "IMM32.dll"), stdcall, UInt32,
(Ptr{Cvoid}, UInt32),
param0, param1)
# param0 : HKL -> Ptr{Cvoid}
# param1 : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t ImmGetProperty(
void* param0,
uint32_t param1);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmGetProperty(param0, param1)
-- param0 : HKL
-- param1 : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmGetProperty = lib.func('__stdcall', 'ImmGetProperty', 'uint32_t', ['void *', 'uint32_t']);
// ImmGetProperty(param0, param1)
// param0 : HKL -> 'void *'
// param1 : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IMM32.dll", {
ImmGetProperty: { parameters: ["pointer", "u32"], result: "u32" },
});
// lib.symbols.ImmGetProperty(param0, param1)
// param0 : HKL -> "pointer"
// param1 : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t ImmGetProperty(
void* param0,
uint32_t param1);
C, "IMM32.dll");
// $ffi->ImmGetProperty(param0, param1);
// param0 : HKL
// param1 : 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);
int ImmGetProperty(
Pointer param0, // HKL
int param1 // DWORD
);
}@[Link("imm32")]
lib LibIMM32
fun ImmGetProperty = ImmGetProperty(
param0 : Void*, # HKL
param1 : UInt32 # DWORD
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef ImmGetPropertyNative = Uint32 Function(Pointer<Void>, Uint32);
typedef ImmGetPropertyDart = int Function(Pointer<Void>, int);
final ImmGetProperty = DynamicLibrary.open('IMM32.dll')
.lookupFunction<ImmGetPropertyNative, ImmGetPropertyDart>('ImmGetProperty');
// param0 : HKL -> Pointer<Void>
// param1 : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ImmGetProperty(
param0: THandle; // HKL
param1: DWORD // DWORD
): DWORD; stdcall;
external 'IMM32.dll' name 'ImmGetProperty';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ImmGetProperty"
c_ImmGetProperty :: Ptr () -> Word32 -> IO Word32
-- param0 : HKL -> Ptr ()
-- param1 : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let immgetproperty =
foreign "ImmGetProperty"
((ptr void) @-> uint32_t @-> returning uint32_t)
(* param0 : HKL -> (ptr void) *)
(* param1 : 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 ("ImmGetProperty" imm-get-property :convention :stdcall) :uint32
(param0 :pointer) ; HKL
(param1 :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ImmGetProperty = Win32::API::More->new('IMM32',
'DWORD ImmGetProperty(HANDLE param0, DWORD param1)');
# my $ret = $ImmGetProperty->Call($param0, $param1);
# param0 : HKL -> HANDLE
# param1 : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f ImmSetCompositionStringW — 入力コンテキストの変換文字列や読み文字列を設定する(Unicode版)。