ホーム › UI.Input.Ime › ImmSetCompositionFontA

ImmSetCompositionFontA

関数

変換文字列に使うロゴフォントを設定する(ANSI版)。

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

シグネチャ

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

BOOL ImmSetCompositionFontA(
    HIMC param0,
    LOGFONTA* lplf
);

パラメーター

名前	型	方向	説明
param0	HIMC	in	対象の入力コンテキストハンドル(HIMC)。
lplf	LOGFONTA*	in	設定するフォント情報を含む LOGFONT 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

ImmSetCompositionFontA (ANSI) 関数 (immdev.h) は、コンポジションウィンドウで文字を表示するために使用する論理フォントを設定します。

戻り値

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

解説(Remarks)

この関数は、IMN_SETCOMPOSITIONFONT コマンドをアプリケーションに送信します。アプリケーションがコンポジションウィンドウを使用しない場合でも、文字が適切に表示されるように、適切なフォントを設定する必要があります。これは特に縦書きの場合に当てはまります。

メモ

immdev.h ヘッダーは ImmSetCompositionFont をエイリアスとして定義しており、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 ImmSetCompositionFontA(
    HIMC param0,
    LOGFONTA* lplf
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool ImmSetCompositionFontA(
    IntPtr param0,   // HIMC
    IntPtr lplf   // LOGFONTA*
);

<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmSetCompositionFontA(
    param0 As IntPtr,   ' HIMC
    lplf As IntPtr   ' LOGFONTA*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' param0 : HIMC
' lplf : LOGFONTA*
Declare PtrSafe Function ImmSetCompositionFontA Lib "imm32" ( _
    ByVal param0 As LongPtr, _
    ByVal lplf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ImmSetCompositionFontA = ctypes.windll.imm32.ImmSetCompositionFontA
ImmSetCompositionFontA.restype = wintypes.BOOL
ImmSetCompositionFontA.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    ctypes.c_void_p,  # lplf : LOGFONTA*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmSetCompositionFontA = Fiddle::Function.new(
  lib['ImmSetCompositionFontA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    Fiddle::TYPE_VOIDP,  # lplf : LOGFONTA*
  ],
  Fiddle::TYPE_INT)

#[link(name = "imm32")]
extern "system" {
    fn ImmSetCompositionFontA(
        param0: *mut core::ffi::c_void,  // HIMC
        lplf: *mut LOGFONTA  // LOGFONTA*
    ) -> 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 ImmSetCompositionFontA(IntPtr param0, IntPtr lplf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmSetCompositionFontA' -Namespace Win32 -PassThru
# $api::ImmSetCompositionFontA(param0, lplf)

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

出力引数:

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