CreateDataCache

関数

OLEオブジェクトの表示データをキャッシュするオブジェクトを生成する。

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

シグネチャ

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

HRESULT CreateDataCache(
    IUnknown* pUnkOuter,   // optional
    const GUID* rclsid,
    const GUID* iid,
    void** ppv
);

パラメーター

名前	型	方向	説明
pUnkOuter	IUnknown*	inoptional	キャッシュをアグリゲートの一部として作成する場合は、そのアグリゲートを制御する IUnknown へのポインターを指定します。それ以外の場合、このパラメーターは NULL にする必要があります。
rclsid	GUID*	in	アイコンラベルの生成に使用される CLSID。この値は通常 CLSID_NULL です。
iid	GUID*	in	呼び出し元がキャッシュとの通信に使用するインターフェイスの識別子への参照。この値は通常 IID_IOleCache です(OLE ヘッダーで IOleCache のインターフェイス識別子と等しくなるように定義されています)。
ppv	void**	out	riid で要求されたインターフェイスポインターを受け取るポインター変数のアドレス。正常に戻った場合、*ppvObj には、指定されたキャッシュオブジェクトに対する要求されたインターフェイスポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

OLE が提供するデータキャッシュ実装の新しいインスタンスへのポインターを取得します。

戻り値

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

戻り値	説明
E_NOINTERFACE	riid で表されるインターフェイスがオブジェクトでサポートされていません。パラメーター ppvObj は NULL に設定されます。
E_OUTOFMEMORY	この操作を行うためのメモリが不足しています。
E_INVALIDARG	1 つ以上のパラメーターが無効です。

解説(Remarks)

CreateDataCache によって作成されるキャッシュオブジェクトは、キャッシュを制御するための IOleCache、IOleCache2、および IOleCacheControl インターフェイスをサポートします。また、IPersistStorage、IDataObject(アドバイズシンクなし)、IViewObject、および IViewObject2 インターフェイスもサポートします。

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

各言語での呼び出し定義

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

HRESULT CreateDataCache(
    IUnknown* pUnkOuter,   // optional
    const GUID* rclsid,
    const GUID* iid,
    void** ppv
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CreateDataCache(
    IntPtr pUnkOuter,   // IUnknown* optional
    ref Guid rclsid,   // GUID*
    ref Guid iid,   // GUID*
    IntPtr ppv   // void** out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CreateDataCache(
    pUnkOuter As IntPtr,   ' IUnknown* optional
    ByRef rclsid As Guid,   ' GUID*
    ByRef iid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function

' pUnkOuter : IUnknown* optional
' rclsid : GUID*
' iid : GUID*
' ppv : void** out
Declare PtrSafe Function CreateDataCache Lib "ole32" ( _
    ByVal pUnkOuter As LongPtr, _
    ByVal rclsid As LongPtr, _
    ByVal iid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateDataCache = ctypes.windll.ole32.CreateDataCache
CreateDataCache.restype = ctypes.c_int
CreateDataCache.argtypes = [
    ctypes.c_void_p,  # pUnkOuter : IUnknown* optional
    ctypes.c_void_p,  # rclsid : GUID*
    ctypes.c_void_p,  # iid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CreateDataCache = Fiddle::Function.new(
  lib['CreateDataCache'],
  [
    Fiddle::TYPE_VOIDP,  # pUnkOuter : IUnknown* optional
    Fiddle::TYPE_VOIDP,  # rclsid : GUID*
    Fiddle::TYPE_VOIDP,  # iid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn CreateDataCache(
        pUnkOuter: *mut core::ffi::c_void,  // IUnknown* optional
        rclsid: *const GUID,  // GUID*
        iid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int CreateDataCache(IntPtr pUnkOuter, ref Guid rclsid, ref Guid iid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CreateDataCache' -Namespace Win32 -PassThru
# $api::CreateDataCache(pUnkOuter, rclsid, iid, ppv)

#uselib "OLE32.dll"
#func global CreateDataCache "CreateDataCache" sptr, sptr, sptr, sptr
; CreateDataCache pUnkOuter, varptr(rclsid), varptr(iid), ppv   ; 戻り値は stat
; pUnkOuter : IUnknown* optional -> "sptr"
; rclsid : GUID* -> "sptr"
; iid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global CreateDataCache "CreateDataCache" sptr, var, var, sptr
; res = CreateDataCache(pUnkOuter, rclsid, iid, ppv)
; pUnkOuter : IUnknown* optional -> "sptr"
; rclsid : GUID* -> "var"
; iid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global CreateDataCache "CreateDataCache" sptr, sptr, sptr, sptr
; res = CreateDataCache(pUnkOuter, varptr(rclsid), varptr(iid), ppv)
; pUnkOuter : IUnknown* optional -> "sptr"
; rclsid : GUID* -> "sptr"
; iid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。