Win32 API 日本語リファレンス
ホームDevices.Display › EngAssociateSurface

EngAssociateSurface

関数
サーフェスを論理デバイスに関連付ける。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL EngAssociateSurface(
    HSURF hsurf,
    HDEV hdev,
    DWORD flHooks
);

パラメーター

名前方向説明
hsurfHSURFinhdev に関連付けるサーフェスまたはビットマップへのハンドルです。このハンドルは EngCreateBitmap または EngCreateDeviceBitmap によって返されたものです。
hdevHDEVinサーフェスを関連付けるデバイスへのハンドルです。これは、ドライバーの DrvCompletePDEV 関数に渡された、GDI が作成したハンドルです。
flHooksDWORDin

ドライバーが GDI からフックできる関数を指定します。ドライバーは、flHooks で設定したビットごとに、対応する関数を実装する必要があります。このメンバーは、次の値のビット単位 OR です。

フラグ フックされる関数
HOOK_ALPHABLEND

DrvAlphaBlend

HOOK_BITBLT

DrvBitBlt

HOOK_COPYBITS

DrvCopyBits

HOOK_FILLPATH

DrvFillPath

HOOK_GRADIENTFILL

DrvGradientFill

HOOK_LINETO

DrvLineTo

HOOK_MOVEPANNING 廃止済み
HOOK_PAINT 廃止済み
HOOK_PLGBLT

DrvPlgBlt

HOOK_STRETCHBLT

DrvStretchBlt

HOOK_STRETCHBLTROP

DrvStretchBltROP

HOOK_STROKEANDFILLPATH

DrvStrokeAndFillPath

HOOK_STROKEPATH

DrvStrokePath

HOOK_SYNCHRONIZE

DrvSynchronize または DrvSynchronizeSurface(いずれか一方または両方)

HOOK_SYNCHRONIZEACCESS 廃止済み
HOOK_TEXTOUT

DrvTextOut

HOOK_TRANSPARENTBLT

DrvTransparentBlt

戻り値の型: BOOL

公式ドキュメント

EngAssociateSurface 関数は、指定されたサーフェスが特定のデバイスに属するものとしてマークします。

戻り値

関数が成功した場合、戻り値は TRUE です。それ以外の場合、ドライバーは、実装している GDI 関数にその情報を送り、GDI の戻り値を返す必要があります。

解説(Remarks)

EngAssociateSurface は、プリンタードライバーが「ルール」やデバイスフォントを実装するために、またはディスプレイドライバーが特殊な blt ハードウェアを利用するために使用できます。

hsurf で識別されるサーフェスが標準形式のビットマップである場合、ドライバーは flHooks にビットを設定することで、そのサーフェスに対してどの出力関数を処理するかを指定できます。flHooks にビットを設定すると、特定の出力関数が代わりにドライバーへ送られるようになります。これはフックと呼ばれます。ドライバーが呼び出しをフックしない場合、標準形式のビットマップへの描画時には GDI が自動的にその操作を処理します。

サーフェスが関連付けられると、PDEV の既定のパレットおよびスタイルステップが適用されます。サーフェスは、DrvEnableSurface によって返される前に関連付けられている必要があります。

既定では、ドライバーが DrvCreateDeviceBitmap / DrvDeleteDeviceBitmap を実装してデバイスビットマップをサポートしている場合、GDI はデバイスビットマップへの描画呼び出しとプライマリサーフェスへの描画呼び出しを自動的に同期しません。たとえば、GDI がドライバーの DrvBitBlt 関数を呼び出してデバイスビットマップへ描画している間に、別のスレッドがドライバーの DrvTextOut 実装を実行してプライマリサーフェスへ描画することがあります。さらに、ドライバーが複数のデバイスビットマップへ同時に描画するよう呼び出されることもあります。

DrvEnableSurface がプライマリサーフェスへのハンドルを返した後は、そのハンドルに対して EngAssociateSurface を呼び出さないでください。これを行うと、特定の状況でバグチェックが発生する可能性があります。詳細については、Microsoft サポート技術情報の記事 330248 を参照してください。

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

各言語での呼び出し定義

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

BOOL EngAssociateSurface(
    HSURF hsurf,
    HDEV hdev,
    DWORD flHooks
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool EngAssociateSurface(
    IntPtr hsurf,   // HSURF
    IntPtr hdev,   // HDEV
    uint flHooks   // DWORD
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function EngAssociateSurface(
    hsurf As IntPtr,   ' HSURF
    hdev As IntPtr,   ' HDEV
    flHooks As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hsurf : HSURF
' hdev : HDEV
' flHooks : DWORD
Declare PtrSafe Function EngAssociateSurface Lib "gdi32" ( _
    ByVal hsurf As LongPtr, _
    ByVal hdev As LongPtr, _
    ByVal flHooks As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EngAssociateSurface = ctypes.windll.gdi32.EngAssociateSurface
EngAssociateSurface.restype = wintypes.BOOL
EngAssociateSurface.argtypes = [
    wintypes.HANDLE,  # hsurf : HSURF
    wintypes.HANDLE,  # hdev : HDEV
    wintypes.DWORD,  # flHooks : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procEngAssociateSurface = gdi32.NewProc("EngAssociateSurface")
)

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

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

typedef EngAssociateSurfaceNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef EngAssociateSurfaceDart = int Function(Pointer<Void>, Pointer<Void>, int);
final EngAssociateSurface = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<EngAssociateSurfaceNative, EngAssociateSurfaceDart>('EngAssociateSurface');
// hsurf : HSURF -> Pointer<Void>
// hdev : HDEV -> Pointer<Void>
// flHooks : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EngAssociateSurface(
  hsurf: THandle;   // HSURF
  hdev: THandle;   // HDEV
  flHooks: DWORD   // DWORD
): BOOL; stdcall;
  external 'GDI32.dll' name 'EngAssociateSurface';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EngAssociateSurface"
  c_EngAssociateSurface :: Ptr () -> Ptr () -> Word32 -> IO CInt
-- hsurf : HSURF -> Ptr ()
-- hdev : HDEV -> Ptr ()
-- flHooks : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let engassociatesurface =
  foreign "EngAssociateSurface"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hsurf : HSURF -> (ptr void) *)
(* hdev : HDEV -> (ptr void) *)
(* flHooks : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("EngAssociateSurface" eng-associate-surface :convention :stdcall) :int32
  (hsurf :pointer)   ; HSURF
  (hdev :pointer)   ; HDEV
  (fl-hooks :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EngAssociateSurface = Win32::API::More->new('GDI32',
    'BOOL EngAssociateSurface(HANDLE hsurf, HANDLE hdev, DWORD flHooks)');
# my $ret = $EngAssociateSurface->Call($hsurf, $hdev, $flHooks);
# hsurf : HSURF -> HANDLE
# hdev : HDEV -> HANDLE
# flHooks : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。