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

ImmRegisterWordW

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

シグネチャ

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

BOOL ImmRegisterWordW(
    HKL param0,
    LPCWSTR lpszReading,
    DWORD param2,
    LPCWSTR lpszRegister
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

解説(Remarks)

IME の独立系ソフトウェア ベンダー (ISV) は、IME_REGWORD_STYLE_USER_FIRST から IME_REGWORD_STYLE_USER_LAST の範囲の値で、IME のプライベートなスタイルを定義できます。例:

#define MSIME_NOUN (IME_REGWORD_STYLE_USER_FIRST)
#define MSIME_VERB (IME_REGWORD_STYLE_USER_FIRST + 1)
メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL ImmRegisterWordW(
    HKL param0,
    LPCWSTR lpszReading,
    DWORD param2,
    LPCWSTR lpszRegister
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool ImmRegisterWordW(
    IntPtr param0,   // HKL
    [MarshalAs(UnmanagedType.LPWStr)] string lpszReading,   // LPCWSTR
    uint param2,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpszRegister   // LPCWSTR
);
<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmRegisterWordW(
    param0 As IntPtr,   ' HKL
    <MarshalAs(UnmanagedType.LPWStr)> lpszReading As String,   ' LPCWSTR
    param2 As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpszRegister As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' param0 : HKL
' lpszReading : LPCWSTR
' param2 : DWORD
' lpszRegister : LPCWSTR
Declare PtrSafe Function ImmRegisterWordW Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal lpszReading As LongPtr, _
    ByVal param2 As Long, _
    ByVal lpszRegister As LongPtr) 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

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

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

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmRegisterWordW = imm32.NewProc("ImmRegisterWordW")
)

// param0 (HKL), lpszReading (LPCWSTR), param2 (DWORD), lpszRegister (LPCWSTR)
r1, _, err := procImmRegisterWordW.Call(
	uintptr(param0),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszReading))),
	uintptr(param2),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszRegister))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ImmRegisterWordW(
  param0: THandle;   // HKL
  lpszReading: PWideChar;   // LPCWSTR
  param2: DWORD;   // DWORD
  lpszRegister: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'IMM32.dll' name 'ImmRegisterWordW';
result := DllCall("IMM32\ImmRegisterWordW"
    , "Ptr", param0   ; HKL
    , "WStr", lpszReading   ; LPCWSTR
    , "UInt", param2   ; DWORD
    , "WStr", lpszRegister   ; LPCWSTR
    , "Int")   ; return: BOOL
●ImmRegisterWordW(param0, lpszReading, param2, lpszRegister) = DLL("IMM32.dll", "bool ImmRegisterWordW(void*, char*, dword, char*)")
# 呼び出し: ImmRegisterWordW(param0, lpszReading, param2, lpszRegister)
# param0 : HKL -> "void*"
# lpszReading : LPCWSTR -> "char*"
# param2 : DWORD -> "dword"
# lpszRegister : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

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

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

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

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

(cffi:defcfun ("ImmRegisterWordW" imm-register-word-w :convention :stdcall) :int32
  (param0 :pointer)   ; HKL
  (lpsz-reading (:string :encoding :utf-16le))   ; LPCWSTR
  (param2 :uint32)   ; DWORD
  (lpsz-register (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmRegisterWordW = Win32::API::More->new('IMM32',
    'BOOL ImmRegisterWordW(HANDLE param0, LPCWSTR lpszReading, DWORD param2, LPCWSTR lpszRegister)');
# my $ret = $ImmRegisterWordW->Call($param0, $lpszReading, $param2, $lpszRegister);
# param0 : HKL -> HANDLE
# lpszReading : LPCWSTR -> LPCWSTR
# param2 : DWORD -> DWORD
# lpszRegister : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い