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

ImmSetCompositionFontW

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

シグネチャ

// IMM32.dll  (Unicode / -W)
#include <windows.h>

BOOL ImmSetCompositionFontW(
    HIMC param0,
    LOGFONTW* lplf
);

パラメーター

名前方向説明
param0HIMCin対象の入力コンテキストハンドル(HIMC)。
lplfLOGFONTW*in設定するフォント情報を格納した LOGFONT 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

ImmSetCompositionFontW (Unicode) 関数 (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  (Unicode / -W)
#include <windows.h>

BOOL ImmSetCompositionFontW(
    HIMC param0,
    LOGFONTW* lplf
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IMM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool ImmSetCompositionFontW(
    IntPtr param0,   // HIMC
    IntPtr lplf   // LOGFONTW*
);
<DllImport("IMM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ImmSetCompositionFontW(
    param0 As IntPtr,   ' HIMC
    lplf As IntPtr   ' LOGFONTW*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' param0 : HIMC
' lplf : LOGFONTW*
Declare PtrSafe Function ImmSetCompositionFontW 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

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

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

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmSetCompositionFontW = imm32.NewProc("ImmSetCompositionFontW")
)

// param0 (HIMC), lplf (LOGFONTW*)
r1, _, err := procImmSetCompositionFontW.Call(
	uintptr(param0),
	uintptr(lplf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ImmSetCompositionFontW(
  param0: THandle;   // HIMC
  lplf: Pointer   // LOGFONTW*
): BOOL; stdcall;
  external 'IMM32.dll' name 'ImmSetCompositionFontW';
result := DllCall("IMM32\ImmSetCompositionFontW"
    , "Ptr", param0   ; HIMC
    , "Ptr", lplf   ; LOGFONTW*
    , "Int")   ; return: BOOL
●ImmSetCompositionFontW(param0, lplf) = DLL("IMM32.dll", "bool ImmSetCompositionFontW(void*, void*)")
# 呼び出し: ImmSetCompositionFontW(param0, lplf)
# param0 : HIMC -> "void*"
# lplf : LOGFONTW* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "imm32" fn ImmSetCompositionFontW(
    param0: ?*anyopaque, // HIMC
    lplf: [*c]LOGFONTW // LOGFONTW*
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ImmSetCompositionFontW(
    param0: pointer,  # HIMC
    lplf: ptr LOGFONTW  # LOGFONTW*
): int32 {.importc: "ImmSetCompositionFontW", stdcall, dynlib: "IMM32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "imm32");
extern(Windows)
int ImmSetCompositionFontW(
    void* param0,   // HIMC
    LOGFONTW* lplf   // LOGFONTW*
);
ccall((:ImmSetCompositionFontW, "IMM32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{LOGFONTW}),
      param0, lplf)
# param0 : HIMC -> Ptr{Cvoid}
# lplf : LOGFONTW* -> Ptr{LOGFONTW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t ImmSetCompositionFontW(
    void* param0,
    void* lplf);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmSetCompositionFontW(param0, lplf)
-- param0 : HIMC
-- lplf : LOGFONTW*
-- 構造体/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 ImmSetCompositionFontW = lib.func('__stdcall', 'ImmSetCompositionFontW', 'int32_t', ['void *', 'void *']);
// ImmSetCompositionFontW(param0, lplf)
// param0 : HIMC -> 'void *'
// lplf : LOGFONTW* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmSetCompositionFontW: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.ImmSetCompositionFontW(param0, lplf)
// param0 : HIMC -> "pointer"
// lplf : LOGFONTW* -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ImmSetCompositionFontW(
    void* param0,
    void* lplf);
C, "IMM32.dll");
// $ffi->ImmSetCompositionFontW(param0, lplf);
// param0 : HIMC
// lplf : LOGFONTW*
// 構造体/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 ImmSetCompositionFontW(
        Pointer param0,   // HIMC
        Pointer lplf   // LOGFONTW*
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("imm32")]
lib LibIMM32
  fun ImmSetCompositionFontW = ImmSetCompositionFontW(
    param0 : Void*,   # HIMC
    lplf : LOGFONTW*   # LOGFONTW*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("ImmSetCompositionFontW" imm-set-composition-font-w :convention :stdcall) :int32
  (param0 :pointer)   ; HIMC
  (lplf :pointer))   ; LOGFONTW*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmSetCompositionFontW = Win32::API::More->new('IMM32',
    'BOOL ImmSetCompositionFontW(HANDLE param0, LPVOID lplf)');
# my $ret = $ImmSetCompositionFontW->Call($param0, $lplf);
# param0 : HIMC -> HANDLE
# lplf : LOGFONTW* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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