ホーム › System.Ole › OleCreateLinkFromData

OleCreateLinkFromData

関数

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

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
pSrcDataObj	IDataObject*	in	リンクオブジェクトの作成元となるデータ転送オブジェクト上の IDataObject インターフェイスへのポインター。
riid	GUID*	in	呼び出し元が新しいオブジェクトとの通信に後で使用するインターフェイスの識別子への参照(通常は IID_IOleObject。これは IOleObject のインターフェイス識別子として OLE ヘッダーで定義されています)。
renderopt	DWORD	in	新しく作成されるオブジェクトが持つべき、ローカルにキャッシュされる描画機能またはデータ取得機能を示す、列挙体 OLERENDER の値。追加の考慮事項については、後述の「解説」セクションで説明します。
pFormatEtc	FORMATETC*	in	新しく作成されるオブジェクトが持つべき、ローカルにキャッシュされる描画機能またはデータ取得機能を示す、列挙体 OLERENDER の値へのポインター。選択した OLERENDER の値は、pFormatEtc パラメーターに指定できる値に影響します。
pClientSite	IOleClientSite*	in	IOleClientSite のインスタンスへのポインター。これはオブジェクトがコンテナーにサービスを要求する際の主要なインターフェイスです。このパラメーターには NULL を指定できます。
pStg	IStorage*	in	ストレージオブジェクト上の IStorage インターフェイスへのポインター。このパラメーターに NULL は指定できません。
ppvObj	void**	out	riid で要求したインターフェイスポインターを受け取るポインター変数のアドレス。正常に復帰した場合、ppvObj には新しく作成されたオブジェクト上の要求されたインターフェイスポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

クリップボードから取得されるか、または OLE のドラッグアンドドロップ操作の一部として取得されるデータ転送オブジェクトから、リンクオブジェクトを作成します。

戻り値

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

戻り値	説明
CLIPBRD_E_CANT_OPEN	クリップボードを開くことができません。
OLE_E_CANT_GETMONIKER	オブジェクトのモニカーを抽出できません。
OLE_E_CANT_BINDTOSOURCE	ソースにバインドできません。キャッシュの初期化データを取得するにはバインドが必要です。

解説(Remarks)

OleCreateLinkFromData 関数は、貼り付けリンク操作またはドラッグリンク操作のいずれかを実装するために使用されます。その動作は OleCreateFromData 関数と似ていますが、リンクを作成する点と、異なるデータ形式を探す点が異なります。CF_LINKSOURCE 形式が存在せず、かつ FileName または FileNameW のいずれかのクリップボード形式がデータ転送オブジェクト内に存在する場合、OleCreateLinkFromData は指定されたファイルへのリンクを含むパッケージを作成します。

renderopt パラメーターと pFormatetc パラメーターを使用して、新しく作成されるオブジェクトのキャッシュ機能を制御します。何をキャッシュするかを決定する方法に関する一般的な情報については、renderopt と pFormatetc の相互作用の説明について OLERENDER 列挙体を参照してください。ただし、これらのパラメーターには、OleCreateLinkFromData がキャッシュを初期化する方法に対して、次のような追加の固有の影響があります。

値	説明
OLERENDER_DRAW, OLERENDER_FORMAT	プレゼンテーション情報がソースデータオブジェクト内の他の形式に含まれている場合、その情報が使用されます。情報が存在しない場合、キャッシュは最初は空ですが、オブジェクトが最初に実行されたときに格納されます。新しく作成されたオブジェクトには、他の形式はキャッシュされません。
OLERENDER_NONE, OLERENDER_ASIS	新しく作成されたオブジェクトには何もキャッシュされません。

値

説明

OLERENDER_DRAW, OLERENDER_FORMAT

プレゼンテーション情報がソースデータオブジェクト内の他の形式に含まれている場合、その情報が使用されます。情報が存在しない場合、キャッシュは最初は空ですが、オブジェクトが最初に実行されたときに格納されます。新しく作成されたオブジェクトには、他の形式はキャッシュされません。

OLERENDER_NONE, OLERENDER_ASIS

新しく作成されたオブジェクトには何もキャッシュされません。

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

各言語での呼び出し定義

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

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

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleCreateLinkFromData(
    IntPtr pSrcDataObj,   // IDataObject*
    ref Guid riid,   // 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 OleCreateLinkFromData(
    pSrcDataObj As IntPtr,   ' IDataObject*
    ByRef riid 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*
' riid : GUID*
' renderopt : DWORD
' pFormatEtc : FORMATETC*
' pClientSite : IOleClientSite*
' pStg : IStorage*
' ppvObj : void** out
Declare PtrSafe Function OleCreateLinkFromData Lib "ole32" ( _
    ByVal pSrcDataObj As LongPtr, _
    ByVal riid 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

OleCreateLinkFromData = ctypes.windll.ole32.OleCreateLinkFromData
OleCreateLinkFromData.restype = ctypes.c_int
OleCreateLinkFromData.argtypes = [
    ctypes.c_void_p,  # pSrcDataObj : IDataObject*
    ctypes.c_void_p,  # riid : 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')
OleCreateLinkFromData = Fiddle::Function.new(
  lib['OleCreateLinkFromData'],
  [
    Fiddle::TYPE_VOIDP,  # pSrcDataObj : IDataObject*
    Fiddle::TYPE_VOIDP,  # riid : 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 OleCreateLinkFromData(
        pSrcDataObj: *mut core::ffi::c_void,  // IDataObject*
        riid: *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 OleCreateLinkFromData(IntPtr pSrcDataObj, ref Guid riid, uint renderopt, IntPtr pFormatEtc, IntPtr pClientSite, IntPtr pStg, IntPtr ppvObj);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleCreateLinkFromData' -Namespace Win32 -PassThru
# $api::OleCreateLinkFromData(pSrcDataObj, riid, renderopt, pFormatEtc, pClientSite, pStg, ppvObj)

#uselib "OLE32.dll"
#func global OleCreateLinkFromData "OleCreateLinkFromData" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; OleCreateLinkFromData pSrcDataObj, varptr(riid), renderopt, varptr(pFormatEtc), pClientSite, pStg, ppvObj   ; 戻り値は stat
; pSrcDataObj : IDataObject* -> "sptr"
; riid : 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 OleCreateLinkFromData "OleCreateLinkFromData" sptr, var, int, var, sptr, sptr, sptr
; res = OleCreateLinkFromData(pSrcDataObj, riid, renderopt, pFormatEtc, pClientSite, pStg, ppvObj)
; pSrcDataObj : IDataObject* -> "sptr"
; riid : 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 OleCreateLinkFromData "OleCreateLinkFromData" sptr, sptr, int, sptr, sptr, sptr, sptr
; res = OleCreateLinkFromData(pSrcDataObj, varptr(riid), renderopt, varptr(pFormatEtc), pClientSite, pStg, ppvObj)
; pSrcDataObj : IDataObject* -> "sptr"
; riid : GUID* -> "sptr"
; renderopt : DWORD -> "int"
; pFormatEtc : FORMATETC* -> "sptr"
; pClientSite : IOleClientSite* -> "sptr"
; pStg : IStorage* -> "sptr"
; ppvObj : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。