GetKerningPairsA

関数

フォントのカーニングペア情報を取得する(ANSI版)。

DLLGDI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetKerningPairsA(
    HDC hdc,
    DWORD nPairs,
    KERNINGPAIR* lpKernPair   // optional
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
nPairs	DWORD	in	lpkrnpair 配列内のペアの数。フォントが nNumPairs 個を超えるカーニングペアを持つ場合、この関数はエラーを返します。
lpKernPair	KERNINGPAIR*	outoptional	カーニングペアを受け取る KERNINGPAIR 構造体の配列へのポインター。配列には、少なくとも nNumPairs パラメーターで指定された数の構造体を格納できる必要があります。このパラメーターが NULL の場合、この関数はフォントのカーニングペアの総数を返します。

戻り値の型: DWORD

公式ドキュメント

GetKerningPairs 関数は、指定したデバイスコンテキストの現在選択されているフォントについて、文字のカーニングペアを取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は返されたカーニングペアの数です。

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

解説(Remarks)

メモ

wingdi.h ヘッダーは、GetKerningPairs を、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)

各言語での呼び出し定義

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

DWORD GetKerningPairsA(
    HDC hdc,
    DWORD nPairs,
    KERNINGPAIR* lpKernPair   // optional
);

[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetKerningPairsA(
    IntPtr hdc,   // HDC
    uint nPairs,   // DWORD
    IntPtr lpKernPair   // KERNINGPAIR* optional, out
);

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetKerningPairsA(
    hdc As IntPtr,   ' HDC
    nPairs As UInteger,   ' DWORD
    lpKernPair As IntPtr   ' KERNINGPAIR* optional, out
) As UInteger
End Function

' hdc : HDC
' nPairs : DWORD
' lpKernPair : KERNINGPAIR* optional, out
Declare PtrSafe Function GetKerningPairsA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal nPairs As Long, _
    ByVal lpKernPair As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetKerningPairsA = ctypes.windll.gdi32.GetKerningPairsA
GetKerningPairsA.restype = wintypes.DWORD
GetKerningPairsA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # nPairs : DWORD
    ctypes.c_void_p,  # lpKernPair : KERNINGPAIR* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetKerningPairsA = Fiddle::Function.new(
  lib['GetKerningPairsA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # nPairs : DWORD
    Fiddle::TYPE_VOIDP,  # lpKernPair : KERNINGPAIR* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetKerningPairsA(
        hdc: *mut core::ffi::c_void,  // HDC
        nPairs: u32,  // DWORD
        lpKernPair: *mut KERNINGPAIR  // KERNINGPAIR* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Ansi)]
public static extern uint GetKerningPairsA(IntPtr hdc, uint nPairs, IntPtr lpKernPair);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetKerningPairsA' -Namespace Win32 -PassThru
# $api::GetKerningPairsA(hdc, nPairs, lpKernPair)

#uselib "GDI32.dll"
#func global GetKerningPairsA "GetKerningPairsA" sptr, sptr, sptr
; GetKerningPairsA hdc, nPairs, varptr(lpKernPair)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; nPairs : DWORD -> "sptr"
; lpKernPair : KERNINGPAIR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global GetKerningPairsA "GetKerningPairsA" sptr, int, var
; res = GetKerningPairsA(hdc, nPairs, lpKernPair)
; hdc : HDC -> "sptr"
; nPairs : DWORD -> "int"
; lpKernPair : KERNINGPAIR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global GetKerningPairsA "GetKerningPairsA" sptr, int, sptr
; res = GetKerningPairsA(hdc, nPairs, varptr(lpKernPair))
; hdc : HDC -> "sptr"
; nPairs : DWORD -> "int"
; lpKernPair : KERNINGPAIR* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。