EngEraseSurface

関数

サーフェスの指定矩形を指定色で塗りつぶす。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL EngEraseSurface(
    SURFOBJ* pso,
    RECTL* prcl,
    DWORD iColor
);

パラメーター

名前	型	方向	説明
pso	SURFOBJ*	inout	消去するサーフェスへのポインターです。
prcl	RECTL*	inout	サーフェス上で消去するピクセルを定義する RECTL 構造体へのポインターです。この矩形は下端と右端を含みません。
iColor	DWORD	in	色インデックスを指定します。これは各ピクセルに書き込まれる値へのインデックスです。

戻り値の型: BOOL

公式ドキュメント

EngEraseSurface 関数は GDI を呼び出してサーフェスを消去します。サーフェス上の指定された矩形が、指定された色で塗りつぶされます。

戻り値

関数が成功した場合、戻り値は TRUE です。それ以外の場合は FALSE となり、エラーコードが報告されます。

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

各言語での呼び出し定義

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

BOOL EngEraseSurface(
    SURFOBJ* pso,
    RECTL* prcl,
    DWORD iColor
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool EngEraseSurface(
    IntPtr pso,   // SURFOBJ* in/out
    IntPtr prcl,   // RECTL* in/out
    uint iColor   // DWORD
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function EngEraseSurface(
    pso As IntPtr,   ' SURFOBJ* in/out
    prcl As IntPtr,   ' RECTL* in/out
    iColor As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pso : SURFOBJ* in/out
' prcl : RECTL* in/out
' iColor : DWORD
Declare PtrSafe Function EngEraseSurface Lib "gdi32" ( _
    ByVal pso As LongPtr, _
    ByVal prcl As LongPtr, _
    ByVal iColor As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EngEraseSurface = ctypes.windll.gdi32.EngEraseSurface
EngEraseSurface.restype = wintypes.BOOL
EngEraseSurface.argtypes = [
    ctypes.c_void_p,  # pso : SURFOBJ* in/out
    ctypes.c_void_p,  # prcl : RECTL* in/out
    wintypes.DWORD,  # iColor : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
EngEraseSurface = Fiddle::Function.new(
  lib['EngEraseSurface'],
  [
    Fiddle::TYPE_VOIDP,  # pso : SURFOBJ* in/out
    Fiddle::TYPE_VOIDP,  # prcl : RECTL* in/out
    -Fiddle::TYPE_INT,  # iColor : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn EngEraseSurface(
        pso: *mut SURFOBJ,  // SURFOBJ* in/out
        prcl: *mut RECTL,  // RECTL* in/out
        iColor: 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 EngEraseSurface(IntPtr pso, IntPtr prcl, uint iColor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_EngEraseSurface' -Namespace Win32 -PassThru
# $api::EngEraseSurface(pso, prcl, iColor)

#uselib "GDI32.dll"
#func global EngEraseSurface "EngEraseSurface" sptr, sptr, sptr
; EngEraseSurface varptr(pso), varptr(prcl), iColor   ; 戻り値は stat
; pso : SURFOBJ* in/out -> "sptr"
; prcl : RECTL* in/out -> "sptr"
; iColor : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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