GetKerningPairsW

関数

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

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

シグネチャ

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

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

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

メモ

wingdi.h ヘッダーは GetKerningPairs を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

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

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

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

<DllImport("GDI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetKerningPairsW(
    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 GetKerningPairsW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal nPairs As Long, _
    ByVal lpKernPair 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

GetKerningPairsW = ctypes.windll.gdi32.GetKerningPairsW
GetKerningPairsW.restype = wintypes.DWORD
GetKerningPairsW.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')
GetKerningPairsW = Fiddle::Function.new(
  lib['GetKerningPairsW'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # nPairs : DWORD
    Fiddle::TYPE_VOIDP,  # lpKernPair : KERNINGPAIR* optional, out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "gdi32")]
extern "system" {
    fn GetKerningPairsW(
        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.Unicode)]
public static extern uint GetKerningPairsW(IntPtr hdc, uint nPairs, IntPtr lpKernPair);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetKerningPairsW' -Namespace Win32 -PassThru
# $api::GetKerningPairsW(hdc, nPairs, lpKernPair)

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

出力引数:

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