ホーム › UI.Input.Ime › ImmGetRegisterWordStyleA

ImmGetRegisterWordStyleA

関数

IMEがサポートする単語登録スタイルを取得する(ANSI版)。

DLLIMM32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD ImmGetRegisterWordStyleA(
    HKL param0,
    DWORD nItem,
    STYLEBUFA* lpStyleBuf
);

パラメーター

名前	型	方向	説明
param0	HKL	in	対象IMEのキーボードレイアウトハンドル(HKL)。
nItem	DWORD	in	出力バッファが保持できるスタイルの最大数。IME で利用可能なスタイル数をカウントする場合、アプリケーションはこのパラメーターに 0 を設定します。
lpStyleBuf	STYLEBUFA*	out	関数がスタイル情報を取得する STYLEBUF 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

ImmGetRegisterWordStyleA (ANSI) 関数 (immdev.h) は、指定された入力ロケールに関連付けられた IME がサポートするスタイルの一覧を取得します。

戻り値

バッファにコピーされたスタイルの数を返します。アプリケーションが nItem パラメーターに 0 を設定した場合、戻り値は IME で利用可能なスタイルの数になります。

解説(Remarks)

メモ

immdev.h ヘッダーは ImmGetRegisterWordStyle をエイリアスとして定義しており、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>

DWORD ImmGetRegisterWordStyleA(
    HKL param0,
    DWORD nItem,
    STYLEBUFA* lpStyleBuf
);

[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ImmGetRegisterWordStyleA(
    IntPtr param0,   // HKL
    uint nItem,   // DWORD
    IntPtr lpStyleBuf   // STYLEBUFA* out
);

<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmGetRegisterWordStyleA(
    param0 As IntPtr,   ' HKL
    nItem As UInteger,   ' DWORD
    lpStyleBuf As IntPtr   ' STYLEBUFA* out
) As UInteger
End Function

' param0 : HKL
' nItem : DWORD
' lpStyleBuf : STYLEBUFA* out
Declare PtrSafe Function ImmGetRegisterWordStyleA Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal nItem As Long, _
    ByVal lpStyleBuf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ImmGetRegisterWordStyleA = ctypes.windll.imm32.ImmGetRegisterWordStyleA
ImmGetRegisterWordStyleA.restype = wintypes.DWORD
ImmGetRegisterWordStyleA.argtypes = [
    wintypes.HANDLE,  # param0 : HKL
    wintypes.DWORD,  # nItem : DWORD
    ctypes.c_void_p,  # lpStyleBuf : STYLEBUFA* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetRegisterWordStyleA = Fiddle::Function.new(
  lib['ImmGetRegisterWordStyleA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HKL
    -Fiddle::TYPE_INT,  # nItem : DWORD
    Fiddle::TYPE_VOIDP,  # lpStyleBuf : STYLEBUFA* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "imm32")]
extern "system" {
    fn ImmGetRegisterWordStyleA(
        param0: *mut core::ffi::c_void,  // HKL
        nItem: u32,  // DWORD
        lpStyleBuf: *mut STYLEBUFA  // STYLEBUFA* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Ansi)]
public static extern uint ImmGetRegisterWordStyleA(IntPtr param0, uint nItem, IntPtr lpStyleBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetRegisterWordStyleA' -Namespace Win32 -PassThru
# $api::ImmGetRegisterWordStyleA(param0, nItem, lpStyleBuf)

#uselib "IMM32.dll"
#func global ImmGetRegisterWordStyleA "ImmGetRegisterWordStyleA" sptr, sptr, sptr
; ImmGetRegisterWordStyleA param0, nItem, varptr(lpStyleBuf)   ; 戻り値は stat
; param0 : HKL -> "sptr"
; nItem : DWORD -> "sptr"
; lpStyleBuf : STYLEBUFA* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IMM32.dll"
#cfunc global ImmGetRegisterWordStyleA "ImmGetRegisterWordStyleA" sptr, int, var
; res = ImmGetRegisterWordStyleA(param0, nItem, lpStyleBuf)
; param0 : HKL -> "sptr"
; nItem : DWORD -> "int"
; lpStyleBuf : STYLEBUFA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IMM32.dll"
#cfunc global ImmGetRegisterWordStyleA "ImmGetRegisterWordStyleA" sptr, int, sptr
; res = ImmGetRegisterWordStyleA(param0, nItem, varptr(lpStyleBuf))
; param0 : HKL -> "sptr"
; nItem : DWORD -> "int"
; lpStyleBuf : STYLEBUFA* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。