ホーム › Devices.Display › BRUSHOBJ_pvGetRbrush

BRUSHOBJ_pvGetRbrush

関数

ブラシオブジェクトの実現済みブラシへのポインタを取得する。

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

シグネチャ

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

void* BRUSHOBJ_pvGetRbrush(
    BRUSHOBJ* pbo
);

パラメーター

名前	型	方向	説明
pbo	BRUSHOBJ*	inout	実体化を要求する BRUSHOBJ 構造体へのポインターです。

戻り値の型: void*

公式ドキュメント

BRUSHOBJ_pvGetRbrush 関数は、指定したブラシのドライバーによる実体化(realization)へのポインターを取得します。

戻り値

関数が成功した場合、戻り値は実体化されたブラシへのポインターです。ブラシを実体化できない場合、戻り値は null となり、エラーコードがログに記録されます。

解説(Remarks)

BRUSHOBJ_pvGetRbrush は、ブラシがまだ実体化されていないパターンブラシである場合に呼び出されます。すなわち、BRUSHOBJ 構造体の iSolidColor メンバーが 0xFFFFFFFF で、かつ pvRbrush メンバーが null の場合に呼び出されます。

BRUSHOBJ_pvGetRbrush が呼び出された時点でブラシがまだ実体化されていない場合、GDI はドライバーが提供する DrvRealizeBrush 関数を呼び出して、ドライバーによるブラシの実体化を取得します。高速化のため、GDI はこの実体化を BRUSHOBJ 構造体の pvRbrush メンバーにキャッシュします。これにより、アプリケーションがこのブラシを別の描画操作で再利用する際に、ドライバーは BRUSHOBJ_pvGetRbrush を再度呼び出す必要がなくなります。

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

各言語での呼び出し定義

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

void* BRUSHOBJ_pvGetRbrush(
    BRUSHOBJ* pbo
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern IntPtr BRUSHOBJ_pvGetRbrush(
    IntPtr pbo   // BRUSHOBJ* in/out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function BRUSHOBJ_pvGetRbrush(
    pbo As IntPtr   ' BRUSHOBJ* in/out
) As IntPtr
End Function

' pbo : BRUSHOBJ* in/out
Declare PtrSafe Function BRUSHOBJ_pvGetRbrush Lib "gdi32" ( _
    ByVal pbo As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BRUSHOBJ_pvGetRbrush = ctypes.windll.gdi32.BRUSHOBJ_pvGetRbrush
BRUSHOBJ_pvGetRbrush.restype = ctypes.c_void_p
BRUSHOBJ_pvGetRbrush.argtypes = [
    ctypes.c_void_p,  # pbo : BRUSHOBJ* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
BRUSHOBJ_pvGetRbrush = Fiddle::Function.new(
  lib['BRUSHOBJ_pvGetRbrush'],
  [
    Fiddle::TYPE_VOIDP,  # pbo : BRUSHOBJ* in/out
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "gdi32")]
extern "system" {
    fn BRUSHOBJ_pvGetRbrush(
        pbo: *mut BRUSHOBJ  // BRUSHOBJ* in/out
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll")]
public static extern IntPtr BRUSHOBJ_pvGetRbrush(IntPtr pbo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_BRUSHOBJ_pvGetRbrush' -Namespace Win32 -PassThru
# $api::BRUSHOBJ_pvGetRbrush(pbo)

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

出力引数:

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