Win32 API 日本語リファレンス
ホームSystem.Ole › OleDraw

OleDraw

関数
OLEオブジェクトを指定デバイスコンテキストに描画する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT OleDraw(
    IUnknown* pUnknown,
    DWORD dwAspect,
    HDC hdcDraw,
    RECT* lprcBounds
);

パラメーター

名前方向説明
pUnknownIUnknown*in描画対象のビューオブジェクト上の IUnknown インターフェイスへのポインター。
dwAspectDWORDinオブジェクトをどのように表現するか。表現には、コンテンツ、アイコン、サムネイル、印刷ドキュメントなどがあります。指定可能な値は DVASPECT 列挙体から取得します。
hdcDrawHDCin描画先のデバイスコンテキスト。メタファイルのデバイスコンテキストは指定できません。
lprcBoundsRECT*inオブジェクトを描画する矩形を指定する RECT 構造体へのポインター。このパラメーターは RECTL 構造体に変換されて IViewObject::Draw に渡されます。

戻り値の型: HRESULT

公式ドキュメント

OleDraw 関数 (ole2.h) を使用すると、オブジェクトをより簡単に描画できます。IViewObject::Draw を直接呼び出す代わりに使用できます。

戻り値

この関数は成功時に S_OK を返します。その他に返される可能性のある値を以下に示します。

戻り値 説明
OLE_E_BLANK
描画するデータがありません。
E_ABORT
描画操作が中止されました。
VIEW_E_DRAW
描画するデータがありません。
OLE_E_INVALIDRECT
矩形が無効です。
E_INVALIDARG
1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY
操作に必要なメモリが不足しています。
DV_E_NOIVIEWOBJECT
オブジェクトが IViewObject インターフェイスをサポートしていません。

解説(Remarks)

OleDraw ヘルパー関数は、指定されたオブジェクト (pUnk) に対して QueryInterface メソッドを呼び出し、そのオブジェクト上の IViewObject インターフェイスを要求します。次に、OleDrawRECT 構造体を RECTL 構造体に変換し、以下のように IViewObject::Draw を呼び出します。

lpViewObj->Draw(dwAspect,-1,0,0,0,hdcDraw,&rectl,0,0,0);

この関数は、メタファイルへの描画に必要なパラメーターを指定しないため、メタファイルへの描画には使用しないでください。

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

各言語での呼び出し定義

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

HRESULT OleDraw(
    IUnknown* pUnknown,
    DWORD dwAspect,
    HDC hdcDraw,
    RECT* lprcBounds
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleDraw(
    IntPtr pUnknown,   // IUnknown*
    uint dwAspect,   // DWORD
    IntPtr hdcDraw,   // HDC
    IntPtr lprcBounds   // RECT*
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleDraw(
    pUnknown As IntPtr,   ' IUnknown*
    dwAspect As UInteger,   ' DWORD
    hdcDraw As IntPtr,   ' HDC
    lprcBounds As IntPtr   ' RECT*
) As Integer
End Function
' pUnknown : IUnknown*
' dwAspect : DWORD
' hdcDraw : HDC
' lprcBounds : RECT*
Declare PtrSafe Function OleDraw Lib "ole32" ( _
    ByVal pUnknown As LongPtr, _
    ByVal dwAspect As Long, _
    ByVal hdcDraw As LongPtr, _
    ByVal lprcBounds As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OleDraw = ctypes.windll.ole32.OleDraw
OleDraw.restype = ctypes.c_int
OleDraw.argtypes = [
    ctypes.c_void_p,  # pUnknown : IUnknown*
    wintypes.DWORD,  # dwAspect : DWORD
    wintypes.HANDLE,  # hdcDraw : HDC
    ctypes.c_void_p,  # lprcBounds : RECT*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleDraw = Fiddle::Function.new(
  lib['OleDraw'],
  [
    Fiddle::TYPE_VOIDP,  # pUnknown : IUnknown*
    -Fiddle::TYPE_INT,  # dwAspect : DWORD
    Fiddle::TYPE_VOIDP,  # hdcDraw : HDC
    Fiddle::TYPE_VOIDP,  # lprcBounds : RECT*
  ],
  Fiddle::TYPE_INT)
#[link(name = "ole32")]
extern "system" {
    fn OleDraw(
        pUnknown: *mut core::ffi::c_void,  // IUnknown*
        dwAspect: u32,  // DWORD
        hdcDraw: *mut core::ffi::c_void,  // HDC
        lprcBounds: *mut RECT  // RECT*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleDraw(IntPtr pUnknown, uint dwAspect, IntPtr hdcDraw, IntPtr lprcBounds);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleDraw' -Namespace Win32 -PassThru
# $api::OleDraw(pUnknown, dwAspect, hdcDraw, lprcBounds)
#uselib "OLE32.dll"
#func global OleDraw "OleDraw" sptr, sptr, sptr, sptr
; OleDraw pUnknown, dwAspect, hdcDraw, varptr(lprcBounds)   ; 戻り値は stat
; pUnknown : IUnknown* -> "sptr"
; dwAspect : DWORD -> "sptr"
; hdcDraw : HDC -> "sptr"
; lprcBounds : RECT* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLE32.dll"
#cfunc global OleDraw "OleDraw" sptr, int, sptr, var
; res = OleDraw(pUnknown, dwAspect, hdcDraw, lprcBounds)
; pUnknown : IUnknown* -> "sptr"
; dwAspect : DWORD -> "int"
; hdcDraw : HDC -> "sptr"
; lprcBounds : RECT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT OleDraw(IUnknown* pUnknown, DWORD dwAspect, HDC hdcDraw, RECT* lprcBounds)
#uselib "OLE32.dll"
#cfunc global OleDraw "OleDraw" intptr, int, intptr, var
; res = OleDraw(pUnknown, dwAspect, hdcDraw, lprcBounds)
; pUnknown : IUnknown* -> "intptr"
; dwAspect : DWORD -> "int"
; hdcDraw : HDC -> "intptr"
; lprcBounds : RECT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procOleDraw = ole32.NewProc("OleDraw")
)

// pUnknown (IUnknown*), dwAspect (DWORD), hdcDraw (HDC), lprcBounds (RECT*)
r1, _, err := procOleDraw.Call(
	uintptr(pUnknown),
	uintptr(dwAspect),
	uintptr(hdcDraw),
	uintptr(lprcBounds),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function OleDraw(
  pUnknown: Pointer;   // IUnknown*
  dwAspect: DWORD;   // DWORD
  hdcDraw: THandle;   // HDC
  lprcBounds: Pointer   // RECT*
): Integer; stdcall;
  external 'OLE32.dll' name 'OleDraw';
result := DllCall("OLE32\OleDraw"
    , "Ptr", pUnknown   ; IUnknown*
    , "UInt", dwAspect   ; DWORD
    , "Ptr", hdcDraw   ; HDC
    , "Ptr", lprcBounds   ; RECT*
    , "Int")   ; return: HRESULT
●OleDraw(pUnknown, dwAspect, hdcDraw, lprcBounds) = DLL("OLE32.dll", "int OleDraw(void*, dword, void*, void*)")
# 呼び出し: OleDraw(pUnknown, dwAspect, hdcDraw, lprcBounds)
# pUnknown : IUnknown* -> "void*"
# dwAspect : DWORD -> "dword"
# hdcDraw : HDC -> "void*"
# lprcBounds : RECT* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef OleDrawNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>);
typedef OleDrawDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final OleDraw = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<OleDrawNative, OleDrawDart>('OleDraw');
// pUnknown : IUnknown* -> Pointer<Void>
// dwAspect : DWORD -> Uint32
// hdcDraw : HDC -> Pointer<Void>
// lprcBounds : RECT* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OleDraw(
  pUnknown: Pointer;   // IUnknown*
  dwAspect: DWORD;   // DWORD
  hdcDraw: THandle;   // HDC
  lprcBounds: Pointer   // RECT*
): Integer; stdcall;
  external 'OLE32.dll' name 'OleDraw';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OleDraw"
  c_OleDraw :: Ptr () -> Word32 -> Ptr () -> Ptr () -> IO Int32
-- pUnknown : IUnknown* -> Ptr ()
-- dwAspect : DWORD -> Word32
-- hdcDraw : HDC -> Ptr ()
-- lprcBounds : RECT* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let oledraw =
  foreign "OleDraw"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pUnknown : IUnknown* -> (ptr void) *)
(* dwAspect : DWORD -> uint32_t *)
(* hdcDraw : HDC -> (ptr void) *)
(* lprcBounds : RECT* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("OleDraw" ole-draw :convention :stdcall) :int32
  (p-unknown :pointer)   ; IUnknown*
  (dw-aspect :uint32)   ; DWORD
  (hdc-draw :pointer)   ; HDC
  (lprc-bounds :pointer))   ; RECT*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleDraw = Win32::API::More->new('OLE32',
    'int OleDraw(LPVOID pUnknown, DWORD dwAspect, HANDLE hdcDraw, LPVOID lprcBounds)');
# my $ret = $OleDraw->Call($pUnknown, $dwAspect, $hdcDraw, $lprcBounds);
# pUnknown : IUnknown* -> LPVOID
# dwAspect : DWORD -> DWORD
# hdcDraw : HDC -> HANDLE
# lprcBounds : RECT* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型