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

GetTextAlign

関数
DCの現在のテキスト配置設定を取得する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

TEXT_ALIGN_OPTIONS GetTextAlign(
    HDC hdc
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。

戻り値の型: TEXT_ALIGN_OPTIONS

公式ドキュメント

GetTextAlign 関数は、指定したデバイスコンテキストのテキスト配置設定を取得します。

戻り値

関数が成功した場合、戻り値はテキスト配置フラグの状態です。戻り値の詳細については、「解説」セクションを参照してください。戻り値は、次の値の組み合わせです。

意味
TA_BASELINE 基準点はテキストのベースライン上にあります。
TA_BOTTOM 基準点は外接矩形の下端にあります。
TA_TOP 基準点は外接矩形の上端にあります。
TA_CENTER 基準点は外接矩形の中央に水平方向で揃えられます。
TA_LEFT 基準点は外接矩形の左端にあります。
TA_RIGHT 基準点は外接矩形の右端にあります。
TA_RTLREADING Windows の中東言語版: テキストは、既定の左から右への順序ではなく、右から左への読み取り順序でレイアウトされます。これは、デバイスコンテキストに選択されているフォントがヘブライ語またはアラビア語の場合にのみ適用されます。
TA_NOUPDATECP 各テキスト出力呼び出しの後、現在位置は更新されません。
TA_UPDATECP 各テキスト出力呼び出しの後、現在位置が更新されます。

現在のフォントが(漢字のように)垂直方向の既定ベースラインを持つ場合は、TA_BASELINETA_CENTER の代わりに次の値が使用されます。

意味
VTA_BASELINE 基準点はテキストのベースライン上にあります。
VTA_CENTER 基準点は外接矩形の中央に垂直方向で揃えられます。

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

解説(Remarks)

外接矩形とは、テキスト文字列内のすべての文字セルを囲む矩形です。その寸法は、GetTextExtentPoint32 関数を呼び出すことで取得できます。

テキスト配置フラグは、TextOut 関数および ExtTextOut 関数が、TextOut または ExtTextOut に渡された文字列の基準点を基準として、テキスト文字列をどのように配置するかを決定します。

テキスト配置フラグは必ずしも単一ビットのフラグではなく、ゼロに等しい場合もあります。フラグは、次の一覧に示すように、関連するフラグのグループ単位で調べる必要があります。

現在のフォントが垂直方向の既定ベースラインを持つ場合、関連するフラグは次の一覧に示すとおりです。

この関数の戻り値に特定のフラグが設定されているかどうかを確認するには:

  1. そのフラグとそれに関連するフラグにビットごとの OR 演算子を適用します。
  2. その結果と戻り値にビットごとの AND 演算子を適用します。
  3. この結果とフラグが等しいかどうかをテストします。

例については、テキスト配置の設定を参照してください。

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

各言語での呼び出し定義

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

TEXT_ALIGN_OPTIONS GetTextAlign(
    HDC hdc
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint GetTextAlign(
    IntPtr hdc   // HDC
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetTextAlign(
    hdc As IntPtr   ' HDC
) As UInteger
End Function
' hdc : HDC
Declare PtrSafe Function GetTextAlign Lib "gdi32" ( _
    ByVal hdc As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetTextAlign = ctypes.windll.gdi32.GetTextAlign
GetTextAlign.restype = wintypes.DWORD
GetTextAlign.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetTextAlign = gdi32.NewProc("GetTextAlign")
)

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

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

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

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

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

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

関連項目

公式の関連項目
使用する型