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

ImmDisableTextFrameService

関数
指定スレッドのテキストフレームサービスを無効化する。
DLLIMM32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL ImmDisableTextFrameService(
    DWORD idThread
);

パラメーター

名前方向説明
idThreadDWORDinテキスト サービスを無効化するスレッドの識別子です。スレッドはアプリケーションと同じプロセス内に存在する必要があります。現在のスレッドに対してサービスを無効化するには、このパラメーターに 0 を設定します。現在のプロセス内のすべてのスレッドに対してサービスを無効化するには、このパラメーターに –1 を設定します。

戻り値の型: BOOL

公式ドキュメント

ImmDisableTextFrameService 関数 (immdev.h) は、Windows Vista 以降では使用できません。

戻り値

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

解説(Remarks)

アプリケーションは、TSF と互換性のないスレッドを持つ場合にこの関数を呼び出します。

なお、TSF 機能は、TSF、Input Method Manager (IMM32)、または Active Input Method Manager (AIMM 1.2) を使用するように明示的に記述されていないアプリケーションにも提供されます。アプリケーションを TSF、IMM32、AIMM 1.2 を使用するように記述できますが、アプリケーション内にこれらのテクノロジを使用しない特定のコントロールが存在する場合があります。TSF サポートはこうした特定のコントロールに対しても提供されます。この TSF 機能は、システム モジュール User32.dll、Imm32.dll、Win32k.sys、および TSF モジュール Msctf.dll、Msimtf.dll のすべてのダイナミック リンク ライブラリ (DLL) が読み込まれている場合に、Windows XP 以降で利用できます。

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

各言語での呼び出し定義

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

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

ImmDisableTextFrameService = ctypes.windll.imm32.ImmDisableTextFrameService
ImmDisableTextFrameService.restype = wintypes.BOOL
ImmDisableTextFrameService.argtypes = [
    wintypes.DWORD,  # idThread : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmDisableTextFrameService = Fiddle::Function.new(
  lib['ImmDisableTextFrameService'],
  [
    -Fiddle::TYPE_INT,  # idThread : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "imm32")]
extern "system" {
    fn ImmDisableTextFrameService(
        idThread: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll")]
public static extern bool ImmDisableTextFrameService(uint idThread);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmDisableTextFrameService' -Namespace Win32 -PassThru
# $api::ImmDisableTextFrameService(idThread)
#uselib "IMM32.dll"
#func global ImmDisableTextFrameService "ImmDisableTextFrameService" sptr
; ImmDisableTextFrameService idThread   ; 戻り値は stat
; idThread : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IMM32.dll"
#cfunc global ImmDisableTextFrameService "ImmDisableTextFrameService" int
; res = ImmDisableTextFrameService(idThread)
; idThread : DWORD -> "int"
; BOOL ImmDisableTextFrameService(DWORD idThread)
#uselib "IMM32.dll"
#cfunc global ImmDisableTextFrameService "ImmDisableTextFrameService" int
; res = ImmDisableTextFrameService(idThread)
; idThread : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmDisableTextFrameService = imm32.NewProc("ImmDisableTextFrameService")
)

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

extern "imm32" fn ImmDisableTextFrameService(
    idThread: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc ImmDisableTextFrameService(
    idThread: uint32  # DWORD
): int32 {.importc: "ImmDisableTextFrameService", stdcall, dynlib: "IMM32.dll".}
pragma(lib, "imm32");
extern(Windows)
int ImmDisableTextFrameService(
    uint idThread   // DWORD
);
ccall((:ImmDisableTextFrameService, "IMM32.dll"), stdcall, Int32,
      (UInt32,),
      idThread)
# idThread : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ImmDisableTextFrameService(
    uint32_t idThread);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmDisableTextFrameService(idThread)
-- idThread : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmDisableTextFrameService = lib.func('__stdcall', 'ImmDisableTextFrameService', 'int32_t', ['uint32_t']);
// ImmDisableTextFrameService(idThread)
// idThread : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmDisableTextFrameService: { parameters: ["u32"], result: "i32" },
});
// lib.symbols.ImmDisableTextFrameService(idThread)
// idThread : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ImmDisableTextFrameService(
    uint32_t idThread);
C, "IMM32.dll");
// $ffi->ImmDisableTextFrameService(idThread);
// idThread : 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);
    boolean ImmDisableTextFrameService(
        int idThread   // DWORD
    );
}
@[Link("imm32")]
lib LibIMM32
  fun ImmDisableTextFrameService = ImmDisableTextFrameService(
    idThread : 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 ImmDisableTextFrameServiceNative = Int32 Function(Uint32);
typedef ImmDisableTextFrameServiceDart = int Function(int);
final ImmDisableTextFrameService = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmDisableTextFrameServiceNative, ImmDisableTextFrameServiceDart>('ImmDisableTextFrameService');
// idThread : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmDisableTextFrameService(
  idThread: DWORD   // DWORD
): BOOL; stdcall;
  external 'IMM32.dll' name 'ImmDisableTextFrameService';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmDisableTextFrameService"
  c_ImmDisableTextFrameService :: Word32 -> IO CInt
-- idThread : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immdisabletextframeservice =
  foreign "ImmDisableTextFrameService"
    (uint32_t @-> returning int32_t)
(* idThread : 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 ("ImmDisableTextFrameService" imm-disable-text-frame-service :convention :stdcall) :int32
  (id-thread :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmDisableTextFrameService = Win32::API::More->new('IMM32',
    'BOOL ImmDisableTextFrameService(DWORD idThread)');
# my $ret = $ImmDisableTextFrameService->Call($idThread);
# idThread : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。