ImmGetGuideLineA

関数

IMEのガイドライン情報を取得する(ANSI版)。

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

シグネチャ

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

DWORD ImmGetGuideLineA(
    HIMC param0,
    GET_GUIDE_LINE_TYPE dwIndex,
    LPSTR lpBuf,   // optional
    DWORD dwBufLen
);

パラメーター

名前

型

方向

説明

param0

HIMC

対象の入力コンテキストハンドル(HIMC)。

dwIndex

GET_GUIDE_LINE_TYPE

取得するガイドライン情報の種類です。このパラメーターには次のいずれかの値を指定できます。

値	意味
GGL_LEVEL	エラーレベルを返します。
GGL_INDEX	エラーインデックスを返します。
GGL_STRING	エラーメッセージ文字列を返します。
GGL_PRIVATE	逆変換に関する情報を返します。

lpBuf

LPSTR

outoptional

関数がエラーメッセージ文字列を取得するバッファーへのポインターです。dwIndex が GGL_STRING または GGL_PRIVATE でない場合、または dwBufLen が 0 に設定されている場合、このパラメーターは NULL になります。

dwBufLen

DWORD

出力バッファーのサイズ(バイト単位)です。エラーメッセージ文字列を受け取るために必要なバッファーサイズ(終端の null 文字を含まない)を関数に返させる場合、アプリケーションはこのパラメーターを 0 に設定します。

戻り値の型: DWORD

公式ドキュメント

ImmGetGuideLineA (ANSI) 関数 (immdev.h) は、エラーに関する情報を取得します。アプリケーションはこの情報をユーザーへの通知に使用します。

戻り値

dwIndex パラメーターの値に応じて、エラーレベル、エラーインデックス、またはエラーメッセージ文字列のサイズを返します。dwIndex が GGL_LEVEL の場合、戻り値は次のいずれかの値になります。

値	意味
GL_LEVEL_ERROR	エラーです。IME は処理を続行できない可能性があります。
GL_LEVEL_FATAL	致命的なエラーです。IME は処理を続行できず、データが失われる可能性があります。
GL_LEVEL_INFORMATION	エラーはありません。ユーザー向けの情報があります。
GL_LEVEL_NOGUIDELINE	エラーはありません。以前のエラーメッセージがまだ表示されている場合は削除してください。
GL_LEVEL_WARNING	予期しない入力またはその他の結果です。ユーザーに警告する必要がありますが、IME は処理を続行できます。

dwIndex が GGL_INDEX の場合、戻り値は次のいずれかの値になります。

値	意味
GL_ID_CANNOTSAVE	辞書または統計データを保存できません。
GL_ID_NOCONVERT	IME はこれ以上変換できません。
GL_ID_NODICTIONARY	IME は辞書を見つけられないか、辞書が予期しない形式になっています。
GL_ID_NOMODULE	IME は必要なモジュールを見つけられません。
GL_ID_READINGCONFLICT	読みの競合が発生しました。たとえば、一部の母音を組み合わせて 1 つの文字を形成できない場合などです。
GL_ID_TOOMANYSTROKE	1 つの文字または 1 つの文節に対するストロークが多すぎます。
GL_ID_TYPINGERROR	入力エラーです。IME はこの入力を処理できません。
GL_ID_UNKNOWN	不明なエラーです。エラーメッセージ文字列を参照してください。
GL_ID_INPUTREADING	IME はエンドユーザーからの読み文字入力を受け付けています。
GL_ID_INPUTRADICAL	IME はエンドユーザーからの部首文字入力を受け付けています。
GL_ID_INPUTCODE	IME はエンドユーザーからの文字コード入力を受け付けています。
GL_ID_CHOOSECANDIDATE	IME はエンドユーザーからの候補文字列の選択を受け付けています。
GL_ID_REVERSECONVERSION	GGL_PRIVATE を指定して ImmGetGuideLine を呼び出すことで、逆変換に関する情報を取得できます。取得される情報は CANDIDATELIST 形式です。

dwIndex が GGL_STRING の場合、戻り値はバッファーにコピーされた文字列のバイト数です。ただし、dwBufLen が 0 の場合、戻り値は文字列を受け取るために必要なバッファーサイズ(終端の null 文字を含まない)です。Unicode の場合、dwBufLen が 0 のときの戻り値はサイズ(バイト単位、Unicode の終端 null 文字を含まない)です。

dwIndex が GGL_PRIVATE の場合、戻り値はバッファーにコピーされた情報のバイト数です。dwIndex が GGL_PRIVATE で dwBufLen が 0 の場合、戻り値は情報を受け取るために必要なバッファーサイズです。

解説(Remarks)

アプリケーションは通常、IMN_GUIDELINE コマンドを受信した後にこの関数を呼び出します。

メモ

immdev.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ImmGetGuideLine を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 ImmGetGuideLineA(
    HIMC param0,
    GET_GUIDE_LINE_TYPE dwIndex,
    LPSTR lpBuf,   // optional
    DWORD dwBufLen
);

[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ImmGetGuideLineA(
    IntPtr param0,   // HIMC
    uint dwIndex,   // GET_GUIDE_LINE_TYPE
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuf,   // LPSTR optional, out
    uint dwBufLen   // DWORD
);

<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmGetGuideLineA(
    param0 As IntPtr,   ' HIMC
    dwIndex As UInteger,   ' GET_GUIDE_LINE_TYPE
    <MarshalAs(UnmanagedType.LPStr)> lpBuf As System.Text.StringBuilder,   ' LPSTR optional, out
    dwBufLen As UInteger   ' DWORD
) As UInteger
End Function

' param0 : HIMC
' dwIndex : GET_GUIDE_LINE_TYPE
' lpBuf : LPSTR optional, out
' dwBufLen : DWORD
Declare PtrSafe Function ImmGetGuideLineA Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal lpBuf As String, _
    ByVal dwBufLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ImmGetGuideLineA = ctypes.windll.imm32.ImmGetGuideLineA
ImmGetGuideLineA.restype = wintypes.DWORD
ImmGetGuideLineA.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    wintypes.DWORD,  # dwIndex : GET_GUIDE_LINE_TYPE
    wintypes.LPSTR,  # lpBuf : LPSTR optional, out
    wintypes.DWORD,  # dwBufLen : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetGuideLineA = Fiddle::Function.new(
  lib['ImmGetGuideLineA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    -Fiddle::TYPE_INT,  # dwIndex : GET_GUIDE_LINE_TYPE
    Fiddle::TYPE_VOIDP,  # lpBuf : LPSTR optional, out
    -Fiddle::TYPE_INT,  # dwBufLen : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "imm32")]
extern "system" {
    fn ImmGetGuideLineA(
        param0: *mut core::ffi::c_void,  // HIMC
        dwIndex: u32,  // GET_GUIDE_LINE_TYPE
        lpBuf: *mut u8,  // LPSTR optional, out
        dwBufLen: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IMM32.dll", CharSet = CharSet.Ansi)]
public static extern uint ImmGetGuideLineA(IntPtr param0, uint dwIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuf, uint dwBufLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetGuideLineA' -Namespace Win32 -PassThru
# $api::ImmGetGuideLineA(param0, dwIndex, lpBuf, dwBufLen)

#uselib "IMM32.dll"
#func global ImmGetGuideLineA "ImmGetGuideLineA" sptr, sptr, sptr, sptr
; ImmGetGuideLineA param0, dwIndex, varptr(lpBuf), dwBufLen   ; 戻り値は stat
; param0 : HIMC -> "sptr"
; dwIndex : GET_GUIDE_LINE_TYPE -> "sptr"
; lpBuf : LPSTR optional, out -> "sptr"
; dwBufLen : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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