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

GetCharacterPlacementW

関数
文字列の表示用配置情報を取得する。
DLLGDI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetCharacterPlacementW(
    HDC hdc,
    LPCWSTR lpString,
    INT nCount,
    INT nMexExtent,
    GCP_RESULTSW* lpResults,
    GET_CHARACTER_PLACEMENT_FLAGS dwFlags
);

パラメーター

名前方向
hdcHDCin
lpStringLPCWSTRin
nCountINTin
nMexExtentINTin
lpResultsGCP_RESULTSW*inout
dwFlagsGET_CHARACTER_PLACEMENT_FLAGSin

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetCharacterPlacementW(
    HDC hdc,
    LPCWSTR lpString,
    INT nCount,
    INT nMexExtent,
    GCP_RESULTSW* lpResults,
    GET_CHARACTER_PLACEMENT_FLAGS dwFlags
);
[DllImport("GDI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetCharacterPlacementW(
    IntPtr hdc,   // HDC
    [MarshalAs(UnmanagedType.LPWStr)] string lpString,   // LPCWSTR
    int nCount,   // INT
    int nMexExtent,   // INT
    IntPtr lpResults,   // GCP_RESULTSW* in/out
    uint dwFlags   // GET_CHARACTER_PLACEMENT_FLAGS
);
<DllImport("GDI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetCharacterPlacementW(
    hdc As IntPtr,   ' HDC
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String,   ' LPCWSTR
    nCount As Integer,   ' INT
    nMexExtent As Integer,   ' INT
    lpResults As IntPtr,   ' GCP_RESULTSW* in/out
    dwFlags As UInteger   ' GET_CHARACTER_PLACEMENT_FLAGS
) As UInteger
End Function
' hdc : HDC
' lpString : LPCWSTR
' nCount : INT
' nMexExtent : INT
' lpResults : GCP_RESULTSW* in/out
' dwFlags : GET_CHARACTER_PLACEMENT_FLAGS
Declare PtrSafe Function GetCharacterPlacementW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpString As LongPtr, _
    ByVal nCount As Long, _
    ByVal nMexExtent As Long, _
    ByVal lpResults As LongPtr, _
    ByVal dwFlags As Long) 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

GetCharacterPlacementW = ctypes.windll.gdi32.GetCharacterPlacementW
GetCharacterPlacementW.restype = wintypes.DWORD
GetCharacterPlacementW.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.LPCWSTR,  # lpString : LPCWSTR
    ctypes.c_int,  # nCount : INT
    ctypes.c_int,  # nMexExtent : INT
    ctypes.c_void_p,  # lpResults : GCP_RESULTSW* in/out
    wintypes.DWORD,  # dwFlags : GET_CHARACTER_PLACEMENT_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetCharacterPlacementW = Fiddle::Function.new(
  lib['GetCharacterPlacementW'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR
    Fiddle::TYPE_INT,  # nCount : INT
    Fiddle::TYPE_INT,  # nMexExtent : INT
    Fiddle::TYPE_VOIDP,  # lpResults : GCP_RESULTSW* in/out
    -Fiddle::TYPE_INT,  # dwFlags : GET_CHARACTER_PLACEMENT_FLAGS
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "gdi32")]
extern "system" {
    fn GetCharacterPlacementW(
        hdc: *mut core::ffi::c_void,  // HDC
        lpString: *const u16,  // LPCWSTR
        nCount: i32,  // INT
        nMexExtent: i32,  // INT
        lpResults: *mut GCP_RESULTSW,  // GCP_RESULTSW* in/out
        dwFlags: u32  // GET_CHARACTER_PLACEMENT_FLAGS
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Unicode)]
public static extern uint GetCharacterPlacementW(IntPtr hdc, [MarshalAs(UnmanagedType.LPWStr)] string lpString, int nCount, int nMexExtent, IntPtr lpResults, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetCharacterPlacementW' -Namespace Win32 -PassThru
# $api::GetCharacterPlacementW(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
#uselib "GDI32.dll"
#func global GetCharacterPlacementW "GetCharacterPlacementW" wptr, wptr, wptr, wptr, wptr, wptr
; GetCharacterPlacementW hdc, lpString, nCount, nMexExtent, varptr(lpResults), dwFlags   ; 戻り値は stat
; hdc : HDC -> "wptr"
; lpString : LPCWSTR -> "wptr"
; nCount : INT -> "wptr"
; nMexExtent : INT -> "wptr"
; lpResults : GCP_RESULTSW* in/out -> "wptr"
; dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global GetCharacterPlacementW "GetCharacterPlacementW" sptr, wstr, int, int, var, int
; res = GetCharacterPlacementW(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
; hdc : HDC -> "sptr"
; lpString : LPCWSTR -> "wstr"
; nCount : INT -> "int"
; nMexExtent : INT -> "int"
; lpResults : GCP_RESULTSW* in/out -> "var"
; dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetCharacterPlacementW(HDC hdc, LPCWSTR lpString, INT nCount, INT nMexExtent, GCP_RESULTSW* lpResults, GET_CHARACTER_PLACEMENT_FLAGS dwFlags)
#uselib "GDI32.dll"
#cfunc global GetCharacterPlacementW "GetCharacterPlacementW" intptr, wstr, int, int, var, int
; res = GetCharacterPlacementW(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
; hdc : HDC -> "intptr"
; lpString : LPCWSTR -> "wstr"
; nCount : INT -> "int"
; nMexExtent : INT -> "int"
; lpResults : GCP_RESULTSW* in/out -> "var"
; dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetCharacterPlacementW = gdi32.NewProc("GetCharacterPlacementW")
)

// hdc (HDC), lpString (LPCWSTR), nCount (INT), nMexExtent (INT), lpResults (GCP_RESULTSW* in/out), dwFlags (GET_CHARACTER_PLACEMENT_FLAGS)
r1, _, err := procGetCharacterPlacementW.Call(
	uintptr(hdc),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString))),
	uintptr(nCount),
	uintptr(nMexExtent),
	uintptr(lpResults),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetCharacterPlacementW(
  hdc: THandle;   // HDC
  lpString: PWideChar;   // LPCWSTR
  nCount: Integer;   // INT
  nMexExtent: Integer;   // INT
  lpResults: Pointer;   // GCP_RESULTSW* in/out
  dwFlags: DWORD   // GET_CHARACTER_PLACEMENT_FLAGS
): DWORD; stdcall;
  external 'GDI32.dll' name 'GetCharacterPlacementW';
result := DllCall("GDI32\GetCharacterPlacementW"
    , "Ptr", hdc   ; HDC
    , "WStr", lpString   ; LPCWSTR
    , "Int", nCount   ; INT
    , "Int", nMexExtent   ; INT
    , "Ptr", lpResults   ; GCP_RESULTSW* in/out
    , "UInt", dwFlags   ; GET_CHARACTER_PLACEMENT_FLAGS
    , "UInt")   ; return: DWORD
●GetCharacterPlacementW(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags) = DLL("GDI32.dll", "dword GetCharacterPlacementW(void*, char*, int, int, void*, dword)")
# 呼び出し: GetCharacterPlacementW(hdc, lpString, nCount, nMexExtent, lpResults, dwFlags)
# hdc : HDC -> "void*"
# lpString : LPCWSTR -> "char*"
# nCount : INT -> "int"
# nMexExtent : INT -> "int"
# lpResults : GCP_RESULTSW* in/out -> "void*"
# dwFlags : GET_CHARACTER_PLACEMENT_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。