OleLoadPictureEx

関数

サイズや変換オプションを指定して画像ピクチャを読み込む。

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

シグネチャ

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

HRESULT OleLoadPictureEx(
    IStream* lpstream,
    INT lSize,
    BOOL fRunmode,
    const GUID* riid,
    DWORD xSizeDesired,
    DWORD ySizeDesired,
    LOAD_PICTURE_FLAGS dwFlags,
    void** lplpvObj
);

パラメーター

名前	型	方向	説明
lpstream	IStream*	in	ピクチャのデータを格納するストリームへのポインタ。
lSize	INT	in	ストリームから読み取るバイト数。ストリーム全体を読み取る場合は 0 を指定します。
fRunmode	BOOL	in	KeepOriginalFormat プロパティの初期値の反対の値。TRUE の場合、KeepOriginalFormat は FALSE に設定され、その逆も同様です。
riid	GUID*	in	ppvObj で返すインターフェイスポインタの型を記述するインターフェイスの識別子への参照。
xSizeDesired	DWORD	in	アイコンまたはカーソルの希望する幅。有効な値は 16、32、48 です。システム既定のサイズを使用するには、両方のサイズ引数に LP_DEFAULT を渡します。
ySizeDesired	DWORD	in	アイコンまたはカーソルの希望する高さ。有効な値は 16、32、48 です。システム既定のサイズを使用するには、両方のサイズ引数に LP_DEFAULT を渡します。
dwFlags	LOAD_PICTURE_FLAGS	in	アイコンまたはカーソルの希望する色深度。値は LP_MONOCHROME(モノクロ)、LP_VGACOLOR(16 色)、LP_COLOR(256 色)、または LP_DEFAULT(現在のディスプレイに最適な色深度を選択)です。
lplpvObj	void**	out	riid で要求したインターフェイスポインタを受け取るポインタ変数のアドレス。正常に復帰すると、ppvObj には、モニカで識別されるオブジェクトのストレージ上の、要求されたインターフェイスポインタが格納されます。ppvObj が非 NULL の場合、この関数はそのインターフェイスに対して IUnknown::AddRef を呼び出します。IUnknown::Release を呼び出すのは呼び出し側の責任です。エラーが発生した場合、*ppvObj は NULL に設定されます。

戻り値の型: HRESULT

公式ドキュメント

新しいピクチャオブジェクトを作成し、ストリームの内容からそれを初期化します。これは、OleCreatePictureIndirect を第 1 引数に NULL を指定して呼び出した後、IPersistStream::Load を呼び出すのと同等です。(OleLoadPictureEx)

戻り値

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

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

解説(Remarks)

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

OleLoadPictureEx は、アイコンまたはカーソルのサイズの指定を可能にするほか、カラーカーソルの読み込みもサポートします。

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

各言語での呼び出し定義

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

HRESULT OleLoadPictureEx(
    IStream* lpstream,
    INT lSize,
    BOOL fRunmode,
    const GUID* riid,
    DWORD xSizeDesired,
    DWORD ySizeDesired,
    LOAD_PICTURE_FLAGS dwFlags,
    void** lplpvObj
);

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

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

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

import ctypes
from ctypes import wintypes

OleLoadPictureEx = ctypes.windll.oleaut32.OleLoadPictureEx
OleLoadPictureEx.restype = ctypes.c_int
OleLoadPictureEx.argtypes = [
    ctypes.c_void_p,  # lpstream : IStream*
    ctypes.c_int,  # lSize : INT
    wintypes.BOOL,  # fRunmode : BOOL
    ctypes.c_void_p,  # riid : GUID*
    wintypes.DWORD,  # xSizeDesired : DWORD
    wintypes.DWORD,  # ySizeDesired : DWORD
    wintypes.DWORD,  # dwFlags : LOAD_PICTURE_FLAGS
    ctypes.c_void_p,  # lplpvObj : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
OleLoadPictureEx = Fiddle::Function.new(
  lib['OleLoadPictureEx'],
  [
    Fiddle::TYPE_VOIDP,  # lpstream : IStream*
    Fiddle::TYPE_INT,  # lSize : INT
    Fiddle::TYPE_INT,  # fRunmode : BOOL
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    -Fiddle::TYPE_INT,  # xSizeDesired : DWORD
    -Fiddle::TYPE_INT,  # ySizeDesired : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : LOAD_PICTURE_FLAGS
    Fiddle::TYPE_VOIDP,  # lplpvObj : void** out
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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