ホーム › System.Ole › OleCreatePictureIndirect

OleCreatePictureIndirect

関数

ピクチャ記述子からOLEピクチャオブジェクトを作成する。

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

シグネチャ

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

HRESULT OleCreatePictureIndirect(
    PICTDESC* lpPictDesc,
    const GUID* riid,
    BOOL fOwn,
    void** lplpvObj
);

パラメーター

名前	型	方向	説明
lpPictDesc	PICTDESC*	in	ピクチャの初期状態を含む、呼び出し側が割り当てた構造体へのポインター。指定する構造体を NULL にすると、未初期化のオブジェクトを作成できます。これは、ピクチャを IPersistStream::Load 経由で初期化する必要がある場合に使用します。
riid	GUID*	in	lplpvObj に返すインターフェイスポインターの型を表すインターフェイスの識別子への参照。
fOwn	BOOL	in	TRUE の場合、ピクチャオブジェクトはそのオブジェクトが破棄されるときに自身のピクチャを破棄します。FALSE の場合、ピクチャの破棄は呼び出し側の責任となります。
lplpvObj	void**	out	riid で要求したインターフェイスポインターを受け取るポインター変数のアドレス。正常に復帰した場合、このパラメーターには新しく作成されたオブジェクトの、要求したインターフェイスポインターが格納されます。呼び出しが成功した場合、新しいオブジェクトが不要になったときに、このインターフェイスポインターを通じて Release を呼び出す責任は呼び出し側にあります。呼び出しが失敗した場合、値は NULL に設定されます。

戻り値の型: HRESULT

公式ドキュメント

PICTDESC 構造体に従って初期化された新しいピクチャオブジェクトを作成します。

戻り値

この関数は成功すると S_OK を返します。そのほかに返り得る値には次のものがあります。

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

解説(Remarks)

fOwn パラメーターは、ピクチャオブジェクトが内包するピクチャの GDI ピクチャハンドルを所有するかどうかを示します。所有する場合、ピクチャオブジェクトはオブジェクト自体が破棄されるときに自身のピクチャを破棄します。この関数は、呼び出し側が riid パラメーターで指定した新しいピクチャオブジェクトへのインターフェイスポインターを返します。この呼び出しには QueryInterface が組み込まれています。返されたインターフェイスポインターを通じて Release を呼び出す責任は呼び出し側にあります。

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

各言語での呼び出し定義

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

HRESULT OleCreatePictureIndirect(
    PICTDESC* lpPictDesc,
    const GUID* riid,
    BOOL fOwn,
    void** lplpvObj
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int OleCreatePictureIndirect(
    IntPtr lpPictDesc,   // PICTDESC*
    ref Guid riid,   // GUID*
    bool fOwn,   // BOOL
    IntPtr lplpvObj   // void** out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function OleCreatePictureIndirect(
    lpPictDesc As IntPtr,   ' PICTDESC*
    ByRef riid As Guid,   ' GUID*
    fOwn As Boolean,   ' BOOL
    lplpvObj As IntPtr   ' void** out
) As Integer
End Function

' lpPictDesc : PICTDESC*
' riid : GUID*
' fOwn : BOOL
' lplpvObj : void** out
Declare PtrSafe Function OleCreatePictureIndirect Lib "oleaut32" ( _
    ByVal lpPictDesc As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal fOwn 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

OleCreatePictureIndirect = ctypes.windll.oleaut32.OleCreatePictureIndirect
OleCreatePictureIndirect.restype = ctypes.c_int
OleCreatePictureIndirect.argtypes = [
    ctypes.c_void_p,  # lpPictDesc : PICTDESC*
    ctypes.c_void_p,  # riid : GUID*
    wintypes.BOOL,  # fOwn : BOOL
    ctypes.c_void_p,  # lplpvObj : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
OleCreatePictureIndirect = Fiddle::Function.new(
  lib['OleCreatePictureIndirect'],
  [
    Fiddle::TYPE_VOIDP,  # lpPictDesc : PICTDESC*
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_INT,  # fOwn : BOOL
    Fiddle::TYPE_VOIDP,  # lplpvObj : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn OleCreatePictureIndirect(
        lpPictDesc: *mut PICTDESC,  // PICTDESC*
        riid: *const GUID,  // GUID*
        fOwn: i32,  // BOOL
        lplpvObj: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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