ホーム › System.Ole › OleCreateStaticFromData

OleCreateStaticFromData

関数

データオブジェクトから静的な埋め込みオブジェクトを作成する。

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

シグネチャ

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

HRESULT OleCreateStaticFromData(
    IDataObject* pSrcDataObj,
    const GUID* iid,
    DWORD renderopt,
    FORMATETC* pFormatEtc,
    IOleClientSite* pClientSite,
    IStorage* pStg,
    void** ppvObj
);

パラメーター

名前	型	方向	説明
pSrcDataObj	IDataObject*	in	オブジェクトの作成元となるデータを保持するデータ転送オブジェクト上の IDataObject インターフェイスへのポインターです。
iid	GUID*	in	呼び出し元が新しいオブジェクトと通信するために使用するインターフェイスの識別子への参照です(通常は IID_IOleObject。OLE ヘッダーで IOleObject のインターフェイス識別子として定義されています)。
renderopt	DWORD	in	新しく作成されるコンポーネントにコンテナーが求める、ローカルにキャッシュされる描画機能やデータ取得機能を示す、列挙型 OLERENDER の値です。この関数に描画オプション OLERENDER_NONE または OLERENDER_ASIS を渡すとエラーになります。
pFormatEtc	FORMATETC*	in	renderopt の値として使用される OLERENDER フラグに応じて、FORMATETC 列挙値の 1 つへのポインターになる場合があります。制限については OLERENDER 列挙型を参照してください。
pClientSite	IOleClientSite*	in	オブジェクトがコンテナーにサービスを要求するための主要なインターフェイスである IOleClientSite のインスタンスへのポインターです。このパラメーターには NULL を指定できます。
pStg	IStorage*	in	オブジェクトのストレージとなる IStorage インターフェイスへのポインターです。このパラメーターに NULL を指定することはできません。
ppvObj	void**	out	riid で要求されたインターフェイスポインターを受け取るポインター変数のアドレスです。正常に返ると、*ppvObj には新しく作成されたオブジェクト上の要求されたインターフェイスポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

データ転送オブジェクトから、ネイティブデータを持たず表現のみを含む静的オブジェクトを作成します。

戻り値

この関数は成功すると S_OK を返します。

解説(Remarks)

OleCreateStaticFromData 関数は、IDataObject インターフェイスを提供しているオブジェクトであれば、どのようなオブジェクトでも静的オブジェクトに変換できます。これは OLE のリンクまたは埋め込みにおける「図に変換」オプションを実装する際に役立ちます。

静的オブジェクトは、ソースが OLE でレンダリングされるクリップボード形式である CF_METAFILEPICT、CF_DIB、CF_ BITMAP、CF_ENHMETAFILE のいずれかをサポートしている場合にのみ作成できます。

クリップボードから静的オブジェクトを貼り付けるために OleCreateStaticFromData を呼び出すこともできます。オブジェクトが静的かどうかを判断するには、OleQueryCreateFromData 関数を呼び出します。この関数は、CF_METAFILEPICT、CF_DIB、CF_BITMAP、CF_ENHMETAFILE のいずれかが存在し、OLE 形式が存在しない場合に OLE_S_STATIC を返します。これは、オブジェクトを作成するために OleCreateFromData 関数ではなく OleCreateStaticFromData を呼び出すべきであることを示します。

新しい静的オブジェクトは、CF_METAFILEPICT の場合はクラス CLSID_StaticMetafile、CF_DIB または CF_BITMAP の場合は CLSID_StaticDib、CF_ENHMETAFILE の場合は CLSID_Picture_EnhMetafile になります。静的オブジェクトは、IOleObject::GetMiscStatus から返される OLEMISC_STATIC ビットと OLE_CANTLINKINSIDE ビットを設定します。静的オブジェクトのアスペクトは DVASPECT_CONTENT、LINDEX は -1 になります。

pSrcDataObject は OleCreateStaticFromData が返った後も有効です。pSrcDataObject を解放するのは呼び出し元の責任です。OLE はこれを解放しません。

静的オブジェクト内に複数のプレゼンテーションストリームを持つことはできません。

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

各言語での呼び出し定義

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

HRESULT OleCreateStaticFromData(
    IDataObject* pSrcDataObj,
    const GUID* iid,
    DWORD renderopt,
    FORMATETC* pFormatEtc,
    IOleClientSite* pClientSite,
    IStorage* pStg,
    void** ppvObj
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleCreateStaticFromData(
    IntPtr pSrcDataObj,   // IDataObject*
    ref Guid iid,   // GUID*
    uint renderopt,   // DWORD
    IntPtr pFormatEtc,   // FORMATETC*
    IntPtr pClientSite,   // IOleClientSite*
    IntPtr pStg,   // IStorage*
    IntPtr ppvObj   // void** out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleCreateStaticFromData(
    pSrcDataObj As IntPtr,   ' IDataObject*
    ByRef iid As Guid,   ' GUID*
    renderopt As UInteger,   ' DWORD
    pFormatEtc As IntPtr,   ' FORMATETC*
    pClientSite As IntPtr,   ' IOleClientSite*
    pStg As IntPtr,   ' IStorage*
    ppvObj As IntPtr   ' void** out
) As Integer
End Function

' pSrcDataObj : IDataObject*
' iid : GUID*
' renderopt : DWORD
' pFormatEtc : FORMATETC*
' pClientSite : IOleClientSite*
' pStg : IStorage*
' ppvObj : void** out
Declare PtrSafe Function OleCreateStaticFromData Lib "ole32" ( _
    ByVal pSrcDataObj As LongPtr, _
    ByVal iid As LongPtr, _
    ByVal renderopt As Long, _
    ByVal pFormatEtc As LongPtr, _
    ByVal pClientSite As LongPtr, _
    ByVal pStg As LongPtr, _
    ByVal ppvObj As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

OleCreateStaticFromData = ctypes.windll.ole32.OleCreateStaticFromData
OleCreateStaticFromData.restype = ctypes.c_int
OleCreateStaticFromData.argtypes = [
    ctypes.c_void_p,  # pSrcDataObj : IDataObject*
    ctypes.c_void_p,  # iid : GUID*
    wintypes.DWORD,  # renderopt : DWORD
    ctypes.c_void_p,  # pFormatEtc : FORMATETC*
    ctypes.c_void_p,  # pClientSite : IOleClientSite*
    ctypes.c_void_p,  # pStg : IStorage*
    ctypes.c_void_p,  # ppvObj : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleCreateStaticFromData = Fiddle::Function.new(
  lib['OleCreateStaticFromData'],
  [
    Fiddle::TYPE_VOIDP,  # pSrcDataObj : IDataObject*
    Fiddle::TYPE_VOIDP,  # iid : GUID*
    -Fiddle::TYPE_INT,  # renderopt : DWORD
    Fiddle::TYPE_VOIDP,  # pFormatEtc : FORMATETC*
    Fiddle::TYPE_VOIDP,  # pClientSite : IOleClientSite*
    Fiddle::TYPE_VOIDP,  # pStg : IStorage*
    Fiddle::TYPE_VOIDP,  # ppvObj : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn OleCreateStaticFromData(
        pSrcDataObj: *mut core::ffi::c_void,  // IDataObject*
        iid: *const GUID,  // GUID*
        renderopt: u32,  // DWORD
        pFormatEtc: *mut FORMATETC,  // FORMATETC*
        pClientSite: *mut core::ffi::c_void,  // IOleClientSite*
        pStg: *mut core::ffi::c_void,  // IStorage*
        ppvObj: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleCreateStaticFromData(IntPtr pSrcDataObj, ref Guid iid, uint renderopt, IntPtr pFormatEtc, IntPtr pClientSite, IntPtr pStg, IntPtr ppvObj);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleCreateStaticFromData' -Namespace Win32 -PassThru
# $api::OleCreateStaticFromData(pSrcDataObj, iid, renderopt, pFormatEtc, pClientSite, pStg, ppvObj)

#uselib "OLE32.dll"
#func global OleCreateStaticFromData "OleCreateStaticFromData" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; OleCreateStaticFromData pSrcDataObj, varptr(iid), renderopt, varptr(pFormatEtc), pClientSite, pStg, ppvObj   ; 戻り値は stat
; pSrcDataObj : IDataObject* -> "sptr"
; iid : GUID* -> "sptr"
; renderopt : DWORD -> "sptr"
; pFormatEtc : FORMATETC* -> "sptr"
; pClientSite : IOleClientSite* -> "sptr"
; pStg : IStorage* -> "sptr"
; ppvObj : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global OleCreateStaticFromData "OleCreateStaticFromData" sptr, var, int, var, sptr, sptr, sptr
; res = OleCreateStaticFromData(pSrcDataObj, iid, renderopt, pFormatEtc, pClientSite, pStg, ppvObj)
; pSrcDataObj : IDataObject* -> "sptr"
; iid : GUID* -> "var"
; renderopt : DWORD -> "int"
; pFormatEtc : FORMATETC* -> "var"
; pClientSite : IOleClientSite* -> "sptr"
; pStg : IStorage* -> "sptr"
; ppvObj : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global OleCreateStaticFromData "OleCreateStaticFromData" sptr, sptr, int, sptr, sptr, sptr, sptr
; res = OleCreateStaticFromData(pSrcDataObj, varptr(iid), renderopt, varptr(pFormatEtc), pClientSite, pStg, ppvObj)
; pSrcDataObj : IDataObject* -> "sptr"
; iid : GUID* -> "sptr"
; renderopt : DWORD -> "int"
; pFormatEtc : FORMATETC* -> "sptr"
; pClientSite : IOleClientSite* -> "sptr"
; pStg : IStorage* -> "sptr"
; ppvObj : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。