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

ImmGetCompositionFontA

関数
変換文字列に使うロゴフォント情報を取得する(ANSI版)。
DLLIMM32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL ImmGetCompositionFontA(
    HIMC param0,
    LOGFONTA* lplf
);

パラメーター

名前方向説明
param0HIMCin対象の入力コンテキストハンドル(HIMC)。
lplfLOGFONTA*outフォント情報を取得する LOGFONT 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

ImmGetCompositionFontA (ANSI) 関数 (immdev.h) は、変換ウィンドウで文字を表示するために現在使用されている論理フォントに関する情報を取得します。

戻り値

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

解説(Remarks)

メモ

immdev.h ヘッダーは ImmGetCompositionFont をエイリアスとして定義しており、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 ImmGetCompositionFontA(
    HIMC param0,
    LOGFONTA* lplf
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool ImmGetCompositionFontA(
    IntPtr param0,   // HIMC
    IntPtr lplf   // LOGFONTA* out
);
<DllImport("IMM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ImmGetCompositionFontA(
    param0 As IntPtr,   ' HIMC
    lplf As IntPtr   ' LOGFONTA* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' param0 : HIMC
' lplf : LOGFONTA* out
Declare PtrSafe Function ImmGetCompositionFontA 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

ImmGetCompositionFontA = ctypes.windll.imm32.ImmGetCompositionFontA
ImmGetCompositionFontA.restype = wintypes.BOOL
ImmGetCompositionFontA.argtypes = [
    wintypes.HANDLE,  # param0 : HIMC
    ctypes.c_void_p,  # lplf : LOGFONTA* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetCompositionFontA = Fiddle::Function.new(
  lib['ImmGetCompositionFontA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HIMC
    Fiddle::TYPE_VOIDP,  # lplf : LOGFONTA* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "imm32")]
extern "system" {
    fn ImmGetCompositionFontA(
        param0: *mut core::ffi::c_void,  // HIMC
        lplf: *mut LOGFONTA  // LOGFONTA* out
    ) -> 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 ImmGetCompositionFontA(IntPtr param0, IntPtr lplf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetCompositionFontA' -Namespace Win32 -PassThru
# $api::ImmGetCompositionFontA(param0, lplf)
#uselib "IMM32.dll"
#func global ImmGetCompositionFontA "ImmGetCompositionFontA" sptr, sptr
; ImmGetCompositionFontA param0, varptr(lplf)   ; 戻り値は stat
; param0 : HIMC -> "sptr"
; lplf : LOGFONTA* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IMM32.dll"
#cfunc global ImmGetCompositionFontA "ImmGetCompositionFontA" sptr, var
; res = ImmGetCompositionFontA(param0, lplf)
; param0 : HIMC -> "sptr"
; lplf : LOGFONTA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ImmGetCompositionFontA(HIMC param0, LOGFONTA* lplf)
#uselib "IMM32.dll"
#cfunc global ImmGetCompositionFontA "ImmGetCompositionFontA" intptr, var
; res = ImmGetCompositionFontA(param0, lplf)
; param0 : HIMC -> "intptr"
; lplf : LOGFONTA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmGetCompositionFontA = imm32.NewProc("ImmGetCompositionFontA")
)

// param0 (HIMC), lplf (LOGFONTA* out)
r1, _, err := procImmGetCompositionFontA.Call(
	uintptr(param0),
	uintptr(lplf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ImmGetCompositionFontA(
  param0: THandle;   // HIMC
  lplf: Pointer   // LOGFONTA* out
): BOOL; stdcall;
  external 'IMM32.dll' name 'ImmGetCompositionFontA';
result := DllCall("IMM32\ImmGetCompositionFontA"
    , "Ptr", param0   ; HIMC
    , "Ptr", lplf   ; LOGFONTA* out
    , "Int")   ; return: BOOL
●ImmGetCompositionFontA(param0, lplf) = DLL("IMM32.dll", "bool ImmGetCompositionFontA(void*, void*)")
# 呼び出し: ImmGetCompositionFontA(param0, lplf)
# param0 : HIMC -> "void*"
# lplf : LOGFONTA* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ImmGetCompositionFontANative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef ImmGetCompositionFontADart = int Function(Pointer<Void>, Pointer<Void>);
final ImmGetCompositionFontA = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmGetCompositionFontANative, ImmGetCompositionFontADart>('ImmGetCompositionFontA');
// param0 : HIMC -> Pointer<Void>
// lplf : LOGFONTA* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmGetCompositionFontA(
  param0: THandle;   // HIMC
  lplf: Pointer   // LOGFONTA* out
): BOOL; stdcall;
  external 'IMM32.dll' name 'ImmGetCompositionFontA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmGetCompositionFontA"
  c_ImmGetCompositionFontA :: Ptr () -> Ptr () -> IO CInt
-- param0 : HIMC -> Ptr ()
-- lplf : LOGFONTA* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immgetcompositionfonta =
  foreign "ImmGetCompositionFontA"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* param0 : HIMC -> (ptr void) *)
(* lplf : LOGFONTA* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

(cffi:defcfun ("ImmGetCompositionFontA" imm-get-composition-font-a :convention :stdcall) :int32
  (param0 :pointer)   ; HIMC
  (lplf :pointer))   ; LOGFONTA* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmGetCompositionFontA = Win32::API::More->new('IMM32',
    'BOOL ImmGetCompositionFontA(HANDLE param0, LPVOID lplf)');
# my $ret = $ImmGetCompositionFontA->Call($param0, $lplf);
# param0 : HIMC -> HANDLE
# lplf : LOGFONTA* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型