ホーム › UI.Input.Ime › ImmGetCompositionFontW
ImmGetCompositionFontW
関数変換文字列に使うロゴフォント情報を取得する(Unicode版)。
シグネチャ
// IMM32.dll (Unicode / -W)
#include <windows.h>
BOOL ImmGetCompositionFontW(
HIMC param0,
LOGFONTW* lplf
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| param0 | HIMC | in | 対象の入力コンテキストハンドル(HIMC)。 |
| lplf | LOGFONTW* | out | この関数がフォント情報を取得する LOGFONT 構造体へのポインターです。 |
戻り値の型: BOOL
公式ドキュメント
ImmGetCompositionFontW (Unicode) 関数 (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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IMM32.dll (Unicode / -W)
#include <windows.h>
BOOL ImmGetCompositionFontW(
HIMC param0,
LOGFONTW* lplf
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool ImmGetCompositionFontW(
IntPtr param0, // HIMC
IntPtr lplf // LOGFONTW* out
);<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmGetCompositionFontW(
param0 As IntPtr, ' HIMC
lplf As IntPtr ' LOGFONTW* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' param0 : HIMC
' lplf : LOGFONTW* out
Declare PtrSafe Function ImmGetCompositionFontW Lib "imm32" ( _
ByVal param0 As LongPtr, _
ByVal lplf 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
ImmGetCompositionFontW = ctypes.windll.imm32.ImmGetCompositionFontW
ImmGetCompositionFontW.restype = wintypes.BOOL
ImmGetCompositionFontW.argtypes = [
wintypes.HANDLE, # param0 : HIMC
ctypes.c_void_p, # lplf : LOGFONTW* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IMM32.dll')
ImmGetCompositionFontW = Fiddle::Function.new(
lib['ImmGetCompositionFontW'],
[
Fiddle::TYPE_VOIDP, # param0 : HIMC
Fiddle::TYPE_VOIDP, # lplf : LOGFONTW* out
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "imm32")]
extern "system" {
fn ImmGetCompositionFontW(
param0: *mut core::ffi::c_void, // HIMC
lplf: *mut LOGFONTW // LOGFONTW* out
) -> 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 ImmGetCompositionFontW(IntPtr param0, IntPtr lplf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetCompositionFontW' -Namespace Win32 -PassThru
# $api::ImmGetCompositionFontW(param0, lplf)#uselib "IMM32.dll"
#func global ImmGetCompositionFontW "ImmGetCompositionFontW" wptr, wptr
; ImmGetCompositionFontW param0, varptr(lplf) ; 戻り値は stat
; param0 : HIMC -> "wptr"
; lplf : LOGFONTW* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "IMM32.dll" #cfunc global ImmGetCompositionFontW "ImmGetCompositionFontW" sptr, var ; res = ImmGetCompositionFontW(param0, lplf) ; param0 : HIMC -> "sptr" ; lplf : LOGFONTW* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IMM32.dll" #cfunc global ImmGetCompositionFontW "ImmGetCompositionFontW" sptr, sptr ; res = ImmGetCompositionFontW(param0, varptr(lplf)) ; param0 : HIMC -> "sptr" ; lplf : LOGFONTW* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL ImmGetCompositionFontW(HIMC param0, LOGFONTW* lplf) #uselib "IMM32.dll" #cfunc global ImmGetCompositionFontW "ImmGetCompositionFontW" intptr, var ; res = ImmGetCompositionFontW(param0, lplf) ; param0 : HIMC -> "intptr" ; lplf : LOGFONTW* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL ImmGetCompositionFontW(HIMC param0, LOGFONTW* lplf) #uselib "IMM32.dll" #cfunc global ImmGetCompositionFontW "ImmGetCompositionFontW" intptr, intptr ; res = ImmGetCompositionFontW(param0, varptr(lplf)) ; param0 : HIMC -> "intptr" ; lplf : LOGFONTW* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
imm32 = windows.NewLazySystemDLL("IMM32.dll")
procImmGetCompositionFontW = imm32.NewProc("ImmGetCompositionFontW")
)
// param0 (HIMC), lplf (LOGFONTW* out)
r1, _, err := procImmGetCompositionFontW.Call(
uintptr(param0),
uintptr(lplf),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction ImmGetCompositionFontW(
param0: THandle; // HIMC
lplf: Pointer // LOGFONTW* out
): BOOL; stdcall;
external 'IMM32.dll' name 'ImmGetCompositionFontW';result := DllCall("IMM32\ImmGetCompositionFontW"
, "Ptr", param0 ; HIMC
, "Ptr", lplf ; LOGFONTW* out
, "Int") ; return: BOOL●ImmGetCompositionFontW(param0, lplf) = DLL("IMM32.dll", "bool ImmGetCompositionFontW(void*, void*)")
# 呼び出し: ImmGetCompositionFontW(param0, lplf)
# param0 : HIMC -> "void*"
# lplf : LOGFONTW* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "imm32" fn ImmGetCompositionFontW(
param0: ?*anyopaque, // HIMC
lplf: [*c]LOGFONTW // LOGFONTW* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc ImmGetCompositionFontW(
param0: pointer, # HIMC
lplf: ptr LOGFONTW # LOGFONTW* out
): int32 {.importc: "ImmGetCompositionFontW", stdcall, dynlib: "IMM32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "imm32");
extern(Windows)
int ImmGetCompositionFontW(
void* param0, // HIMC
LOGFONTW* lplf // LOGFONTW* out
);ccall((:ImmGetCompositionFontW, "IMM32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{LOGFONTW}),
param0, lplf)
# param0 : HIMC -> Ptr{Cvoid}
# lplf : LOGFONTW* out -> Ptr{LOGFONTW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t ImmGetCompositionFontW(
void* param0,
void* lplf);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmGetCompositionFontW(param0, lplf)
-- param0 : HIMC
-- lplf : LOGFONTW* out
-- 構造体/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 ImmGetCompositionFontW = lib.func('__stdcall', 'ImmGetCompositionFontW', 'int32_t', ['void *', 'void *']);
// ImmGetCompositionFontW(param0, lplf)
// param0 : HIMC -> 'void *'
// lplf : LOGFONTW* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IMM32.dll", {
ImmGetCompositionFontW: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.ImmGetCompositionFontW(param0, lplf)
// param0 : HIMC -> "pointer"
// lplf : LOGFONTW* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ImmGetCompositionFontW(
void* param0,
void* lplf);
C, "IMM32.dll");
// $ffi->ImmGetCompositionFontW(param0, lplf);
// param0 : HIMC
// lplf : LOGFONTW* 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.UNICODE_OPTIONS);
boolean ImmGetCompositionFontW(
Pointer param0, // HIMC
Pointer lplf // LOGFONTW* out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("imm32")]
lib LibIMM32
fun ImmGetCompositionFontW = ImmGetCompositionFontW(
param0 : Void*, # HIMC
lplf : LOGFONTW* # LOGFONTW* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef ImmGetCompositionFontWNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef ImmGetCompositionFontWDart = int Function(Pointer<Void>, Pointer<Void>);
final ImmGetCompositionFontW = DynamicLibrary.open('IMM32.dll')
.lookupFunction<ImmGetCompositionFontWNative, ImmGetCompositionFontWDart>('ImmGetCompositionFontW');
// param0 : HIMC -> Pointer<Void>
// lplf : LOGFONTW* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ImmGetCompositionFontW(
param0: THandle; // HIMC
lplf: Pointer // LOGFONTW* out
): BOOL; stdcall;
external 'IMM32.dll' name 'ImmGetCompositionFontW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ImmGetCompositionFontW"
c_ImmGetCompositionFontW :: Ptr () -> Ptr () -> IO CInt
-- param0 : HIMC -> Ptr ()
-- lplf : LOGFONTW* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let immgetcompositionfontw =
foreign "ImmGetCompositionFontW"
((ptr void) @-> (ptr void) @-> returning int32_t)
(* param0 : HIMC -> (ptr void) *)
(* lplf : LOGFONTW* 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 ("ImmGetCompositionFontW" imm-get-composition-font-w :convention :stdcall) :int32
(param0 :pointer) ; HIMC
(lplf :pointer)) ; LOGFONTW* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ImmGetCompositionFontW = Win32::API::More->new('IMM32',
'BOOL ImmGetCompositionFontW(HANDLE param0, LPVOID lplf)');
# my $ret = $ImmGetCompositionFontW->Call($param0, $lplf);
# param0 : HIMC -> HANDLE
# lplf : LOGFONTW* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f ImmGetCompositionFontA (ANSI版) — 変換文字列に使うロゴフォント情報を取得する(ANSI版)。
使用する型