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

ImmUnregisterWordA

関数
IMEの辞書から登録単語を削除する(ANSI版)。
DLLIMM32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// IMM32.dll  (ANSI / -A)
#include <windows.h>

BOOL ImmUnregisterWordA(
    HKL param0,
    LPCSTR lpszReading,
    DWORD param2,
    LPCSTR lpszUnregister
);

パラメーター

名前方向説明
param0HKLin対象IMEのキーボードレイアウトハンドル(HKL)。
lpszReadingLPCSTRin削除する文字列に関連付けられた、null 終端の読み文字列へのポインター。
param2DWORDin単語の品詞や種類を示すスタイル値。
lpszUnregisterLPCSTRin削除する登録文字列を指定する、null 終端の文字列へのポインター。

戻り値の型: BOOL

公式ドキュメント

ImmUnregisterWordA (ANSI) 関数 (immdev.h) は、指定された入力ロケールに関連付けられた IME の辞書から登録文字列を削除します。

戻り値

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

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

// IMM32.dll  (ANSI / -A)
#include <windows.h>

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

ImmUnregisterWordA = ctypes.windll.imm32.ImmUnregisterWordA
ImmUnregisterWordA.restype = wintypes.BOOL
ImmUnregisterWordA.argtypes = [
    wintypes.HANDLE,  # param0 : HKL
    wintypes.LPCSTR,  # lpszReading : LPCSTR
    wintypes.DWORD,  # param2 : DWORD
    wintypes.LPCSTR,  # lpszUnregister : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmUnregisterWordA = Fiddle::Function.new(
  lib['ImmUnregisterWordA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HKL
    Fiddle::TYPE_VOIDP,  # lpszReading : LPCSTR
    -Fiddle::TYPE_INT,  # param2 : DWORD
    Fiddle::TYPE_VOIDP,  # lpszUnregister : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "imm32")]
extern "system" {
    fn ImmUnregisterWordA(
        param0: *mut core::ffi::c_void,  // HKL
        lpszReading: *const u8,  // LPCSTR
        param2: u32,  // DWORD
        lpszUnregister: *const u8  // LPCSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", CharSet = CharSet.Ansi)]
public static extern bool ImmUnregisterWordA(IntPtr param0, [MarshalAs(UnmanagedType.LPStr)] string lpszReading, uint param2, [MarshalAs(UnmanagedType.LPStr)] string lpszUnregister);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmUnregisterWordA' -Namespace Win32 -PassThru
# $api::ImmUnregisterWordA(param0, lpszReading, param2, lpszUnregister)
#uselib "IMM32.dll"
#func global ImmUnregisterWordA "ImmUnregisterWordA" sptr, sptr, sptr, sptr
; ImmUnregisterWordA param0, lpszReading, param2, lpszUnregister   ; 戻り値は stat
; param0 : HKL -> "sptr"
; lpszReading : LPCSTR -> "sptr"
; param2 : DWORD -> "sptr"
; lpszUnregister : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IMM32.dll"
#cfunc global ImmUnregisterWordA "ImmUnregisterWordA" sptr, str, int, str
; res = ImmUnregisterWordA(param0, lpszReading, param2, lpszUnregister)
; param0 : HKL -> "sptr"
; lpszReading : LPCSTR -> "str"
; param2 : DWORD -> "int"
; lpszUnregister : LPCSTR -> "str"
; BOOL ImmUnregisterWordA(HKL param0, LPCSTR lpszReading, DWORD param2, LPCSTR lpszUnregister)
#uselib "IMM32.dll"
#cfunc global ImmUnregisterWordA "ImmUnregisterWordA" intptr, str, int, str
; res = ImmUnregisterWordA(param0, lpszReading, param2, lpszUnregister)
; param0 : HKL -> "intptr"
; lpszReading : LPCSTR -> "str"
; param2 : DWORD -> "int"
; lpszUnregister : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmUnregisterWordA = imm32.NewProc("ImmUnregisterWordA")
)

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

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

typedef ImmUnregisterWordANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, Pointer<Utf8>);
typedef ImmUnregisterWordADart = int Function(Pointer<Void>, Pointer<Utf8>, int, Pointer<Utf8>);
final ImmUnregisterWordA = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmUnregisterWordANative, ImmUnregisterWordADart>('ImmUnregisterWordA');
// param0 : HKL -> Pointer<Void>
// lpszReading : LPCSTR -> Pointer<Utf8>
// param2 : DWORD -> Uint32
// lpszUnregister : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmUnregisterWordA(
  param0: THandle;   // HKL
  lpszReading: PAnsiChar;   // LPCSTR
  param2: DWORD;   // DWORD
  lpszUnregister: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'IMM32.dll' name 'ImmUnregisterWordA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmUnregisterWordA"
  c_ImmUnregisterWordA :: Ptr () -> CString -> Word32 -> CString -> IO CInt
-- param0 : HKL -> Ptr ()
-- lpszReading : LPCSTR -> CString
-- param2 : DWORD -> Word32
-- lpszUnregister : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immunregisterworda =
  foreign "ImmUnregisterWordA"
    ((ptr void) @-> string @-> uint32_t @-> string @-> returning int32_t)
(* param0 : HKL -> (ptr void) *)
(* lpszReading : LPCSTR -> string *)
(* param2 : DWORD -> uint32_t *)
(* lpszUnregister : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

(cffi:defcfun ("ImmUnregisterWordA" imm-unregister-word-a :convention :stdcall) :int32
  (param0 :pointer)   ; HKL
  (lpsz-reading :string)   ; LPCSTR
  (param2 :uint32)   ; DWORD
  (lpsz-unregister :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmUnregisterWordA = Win32::API::More->new('IMM32',
    'BOOL ImmUnregisterWordA(HANDLE param0, LPCSTR lpszReading, DWORD param2, LPCSTR lpszUnregister)');
# my $ret = $ImmUnregisterWordA->Call($param0, $lpszReading, $param2, $lpszUnregister);
# param0 : HKL -> HANDLE
# lpszReading : LPCSTR -> LPCSTR
# param2 : DWORD -> DWORD
# lpszUnregister : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い