ホーム › Devices.Display › BRUSHOBJ_pvAllocRbrush

BRUSHOBJ_pvAllocRbrush

関数

ブラシオブジェクトに実現済みブラシ用メモリを確保する。

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

シグネチャ

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

void* BRUSHOBJ_pvAllocRbrush(
    BRUSHOBJ* pbo,
    DWORD cj
);

パラメーター

名前	型	方向	説明
pbo	BRUSHOBJ*	inout	実体化を割り当てる対象の BRUSHOBJ 構造体へのポインターです。
cj	DWORD	in	実体化に必要なサイズをバイト単位で指定します。

戻り値の型: void*

公式ドキュメント

BRUSHOBJ_pvAllocRbrush 関数は、指定したブラシのドライバーによる実体化のためのメモリを割り当てます。

戻り値

関数が成功した場合、戻り値は割り当てられたメモリへのポインターです。失敗した場合は null となり、エラーコードがログに記録されます。

解説(Remarks)

BRUSHOBJ_pvAllocRbrush は、ブラシの実体化のためのメモリを割り当てます。GDI がこのメモリを管理し、ブラシが不要になった時点で破棄します。

この関数は、DrvRealizeBrush の呼び出しに続いて、ブラシの実体化の実装からのみ呼び出してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_pvAllocRbrush(
    BRUSHOBJ* pbo,
    DWORD cj
);

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

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

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

import ctypes
from ctypes import wintypes

BRUSHOBJ_pvAllocRbrush = ctypes.windll.gdi32.BRUSHOBJ_pvAllocRbrush
BRUSHOBJ_pvAllocRbrush.restype = ctypes.c_void_p
BRUSHOBJ_pvAllocRbrush.argtypes = [
    ctypes.c_void_p,  # pbo : BRUSHOBJ* in/out
    wintypes.DWORD,  # cj : DWORD
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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