OleLoadPicture

関数

ストリームから画像を読み込みピクチャオブジェクトを作成する。

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

シグネチャ

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

HRESULT OleLoadPicture(
    IStream* lpstream,
    INT lSize,
    BOOL fRunmode,
    const GUID* riid,
    void** lplpvObj
);

パラメーター

名前	型	方向	説明
lpstream	IStream*	in	ピクチャのデータを含むストリームへのポインター。
lSize	INT	in	ストリームから読み取るバイト数。ストリーム全体を読み取る場合は 0 を指定します。
fRunmode	BOOL	in	KeepOriginalFormat プロパティの初期値の反対の値。TRUE の場合、KeepOriginalFormat は FALSE に設定され、その逆も同様です。
riid	GUID*	in	ppvObj で返すインターフェイスポインターの種類を示すインターフェイスの識別子への参照。
lplpvObj	void**	out	riid で要求されたインターフェイスポインターを受け取るポインター変数のアドレス。正常に返ると、ppvObj にはモニカーで識別されるオブジェクトのストレージ上の、要求されたインターフェイスポインターが格納されます。ppvObj が非 NULL の場合、この関数はそのインターフェイスに対して IUnknown::AddRef を呼び出します。IUnknown::Release を呼び出すのは呼び出し側の責任です。エラーが発生した場合、*ppvObj は NULL に設定されます。

戻り値の型: HRESULT

公式ドキュメント

新しいピクチャオブジェクトを作成し、ストリームの内容を使って初期化します。これは OleCreatePictureIndirect を最初のパラメーターに NULL を指定して呼び出し、続けて IPersistStream::Load を呼び出すのと同等です。(OleLoadPicture)

戻り値

この関数は成功時に S_OK を返します。その他に返される可能性のある値には次のものがあります。

戻り値	説明
E_NOINTERFACE	オブジェクトが指定されたインターフェイスをサポートしていません。
E_POINTER	ストリームが有効ではありません。たとえば NULL である可能性があります。

解説(Remarks)

ストリームは BMP(ビットマップ)、WMF(メタファイル)、または ICO(アイコン)形式である必要があります。OleLoadPicture を使用して作成されたピクチャオブジェクトは、常にその内部リソースの所有権を持ちます(fOwn==TRUE が暗黙的に設定されます)。

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

各言語での呼び出し定義

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

HRESULT OleLoadPicture(
    IStream* lpstream,
    INT lSize,
    BOOL fRunmode,
    const GUID* riid,
    void** lplpvObj
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int OleLoadPicture(
    IntPtr lpstream,   // IStream*
    int lSize,   // INT
    bool fRunmode,   // BOOL
    ref Guid riid,   // GUID*
    IntPtr lplpvObj   // void** out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function OleLoadPicture(
    lpstream As IntPtr,   ' IStream*
    lSize As Integer,   ' INT
    fRunmode As Boolean,   ' BOOL
    ByRef riid As Guid,   ' GUID*
    lplpvObj As IntPtr   ' void** out
) As Integer
End Function

' lpstream : IStream*
' lSize : INT
' fRunmode : BOOL
' riid : GUID*
' lplpvObj : void** out
Declare PtrSafe Function OleLoadPicture Lib "oleaut32" ( _
    ByVal lpstream As LongPtr, _
    ByVal lSize As Long, _
    ByVal fRunmode As Long, _
    ByVal riid As LongPtr, _
    ByVal lplpvObj As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

OleLoadPicture = ctypes.windll.oleaut32.OleLoadPicture
OleLoadPicture.restype = ctypes.c_int
OleLoadPicture.argtypes = [
    ctypes.c_void_p,  # lpstream : IStream*
    ctypes.c_int,  # lSize : INT
    wintypes.BOOL,  # fRunmode : BOOL
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # lplpvObj : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
OleLoadPicture = Fiddle::Function.new(
  lib['OleLoadPicture'],
  [
    Fiddle::TYPE_VOIDP,  # lpstream : IStream*
    Fiddle::TYPE_INT,  # lSize : INT
    Fiddle::TYPE_INT,  # fRunmode : BOOL
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # lplpvObj : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn OleLoadPicture(
        lpstream: *mut core::ffi::c_void,  // IStream*
        lSize: i32,  // INT
        fRunmode: i32,  // BOOL
        riid: *const GUID,  // GUID*
        lplpvObj: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int OleLoadPicture(IntPtr lpstream, int lSize, bool fRunmode, ref Guid riid, IntPtr lplpvObj);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_OleLoadPicture' -Namespace Win32 -PassThru
# $api::OleLoadPicture(lpstream, lSize, fRunmode, riid, lplpvObj)

#uselib "OLEAUT32.dll"
#func global OleLoadPicture "OleLoadPicture" sptr, sptr, sptr, sptr, sptr
; OleLoadPicture lpstream, lSize, fRunmode, varptr(riid), lplpvObj   ; 戻り値は stat
; lpstream : IStream* -> "sptr"
; lSize : INT -> "sptr"
; fRunmode : BOOL -> "sptr"
; riid : GUID* -> "sptr"
; lplpvObj : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLEAUT32.dll"
#cfunc global OleLoadPicture "OleLoadPicture" sptr, int, int, var, sptr
; res = OleLoadPicture(lpstream, lSize, fRunmode, riid, lplpvObj)
; lpstream : IStream* -> "sptr"
; lSize : INT -> "int"
; fRunmode : BOOL -> "int"
; riid : GUID* -> "var"
; lplpvObj : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll"
#cfunc global OleLoadPicture "OleLoadPicture" sptr, int, int, sptr, sptr
; res = OleLoadPicture(lpstream, lSize, fRunmode, varptr(riid), lplpvObj)
; lpstream : IStream* -> "sptr"
; lSize : INT -> "int"
; fRunmode : BOOL -> "int"
; riid : GUID* -> "sptr"
; lplpvObj : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。