Win32 API 日本語リファレンス
ホームGraphics.Gdi › SetTextJustification

SetTextJustification

関数
文字列の均等割付けのため空白に追加する間隔を設定する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll
#include <windows.h>

BOOL SetTextJustification(
    HDC hdc,
    INT extra,
    INT count
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。
extraINTinテキスト行に追加する論理単位での追加空白の合計。現在のマッピングモードが MM_TEXT でない場合、nBreakExtra パラメーターで指定された値は変換され、最も近いピクセルに丸められます。
countINTin行内の区切り文字の数。

戻り値の型: BOOL

公式ドキュメント

SetTextJustification 関数は、テキスト文字列内の区切り文字にシステムが追加する空白の量を指定します。この空白は、アプリケーションが TextOut 関数または ExtTextOut 関数を呼び出したときに追加されます。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

区切り文字は通常は空白文字 (ASCII 32) ですが、フォントによって他の文字として定義される場合があります。フォントの区切り文字を取得するには、GetTextMetrics 関数を使用できます。

TextOut 関数は、指定された追加空白を行内の区切り文字に均等に分配します。

GetTextExtentPoint32 関数は、常に SetTextJustification 関数と組み合わせて使用されます。GetTextExtentPoint32 関数は、両端揃え前の指定行の幅を計算する際に、両端揃えを考慮する場合と考慮しない場合があります。これについての詳細は GetTextExtentPoint32 を参照してください。適切な nBreakExtra 値を計算する前に、この幅を把握しておく必要があります。

SetTextJustification は、異なるフォントの複数の文字列を含む行を両端揃えするために使用できます。この場合、各文字列を個別に両端揃えする必要があります。

両端揃えの際には丸め誤差が発生する可能性があるため、システムは現在の誤差値を定義する累積誤差項を保持します。複数のランを含む行を両端揃えする際、GetTextExtentPoint は次のランの範囲を計算する際にこの誤差項を自動的に使用し、TextOut が誤差を新しいランに反映できるようにします。各行の両端揃えが完了した後、この誤差項が次の行に組み込まれないようにクリアする必要があります。この項は、nBreakExtra を 0 に設定して SetTextJustification を呼び出すことでクリアできます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// GDI32.dll
#include <windows.h>

BOOL SetTextJustification(
    HDC hdc,
    INT extra,
    INT count
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool SetTextJustification(
    IntPtr hdc,   // HDC
    int extra,   // INT
    int count   // INT
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SetTextJustification(
    hdc As IntPtr,   ' HDC
    extra As Integer,   ' INT
    count As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hdc : HDC
' extra : INT
' count : INT
Declare PtrSafe Function SetTextJustification Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal extra As Long, _
    ByVal count As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetTextJustification = ctypes.windll.gdi32.SetTextJustification
SetTextJustification.restype = wintypes.BOOL
SetTextJustification.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # extra : INT
    ctypes.c_int,  # count : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
SetTextJustification = Fiddle::Function.new(
  lib['SetTextJustification'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_INT,  # extra : INT
    Fiddle::TYPE_INT,  # count : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn SetTextJustification(
        hdc: *mut core::ffi::c_void,  // HDC
        extra: i32,  // INT
        count: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool SetTextJustification(IntPtr hdc, int extra, int count);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_SetTextJustification' -Namespace Win32 -PassThru
# $api::SetTextJustification(hdc, extra, count)
#uselib "GDI32.dll"
#func global SetTextJustification "SetTextJustification" sptr, sptr, sptr
; SetTextJustification hdc, extra, count   ; 戻り値は stat
; hdc : HDC -> "sptr"
; extra : INT -> "sptr"
; count : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global SetTextJustification "SetTextJustification" sptr, int, int
; res = SetTextJustification(hdc, extra, count)
; hdc : HDC -> "sptr"
; extra : INT -> "int"
; count : INT -> "int"
; BOOL SetTextJustification(HDC hdc, INT extra, INT count)
#uselib "GDI32.dll"
#cfunc global SetTextJustification "SetTextJustification" intptr, int, int
; res = SetTextJustification(hdc, extra, count)
; hdc : HDC -> "intptr"
; extra : INT -> "int"
; count : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSetTextJustification = gdi32.NewProc("SetTextJustification")
)

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

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

typedef SetTextJustificationNative = Int32 Function(Pointer<Void>, Int32, Int32);
typedef SetTextJustificationDart = int Function(Pointer<Void>, int, int);
final SetTextJustification = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<SetTextJustificationNative, SetTextJustificationDart>('SetTextJustification');
// hdc : HDC -> Pointer<Void>
// extra : INT -> Int32
// count : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetTextJustification(
  hdc: THandle;   // HDC
  extra: Integer;   // INT
  count: Integer   // INT
): BOOL; stdcall;
  external 'GDI32.dll' name 'SetTextJustification';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetTextJustification"
  c_SetTextJustification :: Ptr () -> Int32 -> Int32 -> IO CInt
-- hdc : HDC -> Ptr ()
-- extra : INT -> Int32
-- count : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let settextjustification =
  foreign "SetTextJustification"
    ((ptr void) @-> int32_t @-> int32_t @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* extra : INT -> int32_t *)
(* count : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("SetTextJustification" set-text-justification :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (extra :int32)   ; INT
  (count :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetTextJustification = Win32::API::More->new('GDI32',
    'BOOL SetTextJustification(HANDLE hdc, int extra, int count)');
# my $ret = $SetTextJustification->Call($hdc, $extra, $count);
# hdc : HDC -> HANDLE
# extra : INT -> int
# count : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目