OleCreateFromFile

関数

指定ファイルから埋め込みOLEオブジェクトを作成する。

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

シグネチャ

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

HRESULT OleCreateFromFile(
    const GUID* rclsid,
    LPCWSTR lpszFileName,
    const GUID* riid,
    DWORD renderopt,
    FORMATETC* lpFormatEtc,
    IOleClientSite* pClientSite,
    IStorage* pStg,
    void** ppvObj
);

パラメーター

名前	型	方向	説明
rclsid	GUID*	in	このパラメーターは予約されており、CLSID_NULL でなければなりません。
lpszFileName	LPCWSTR	in	オブジェクトの初期化に使用するファイルのフルパスを指定する文字列へのポインター。
riid	GUID*	in	呼び出し側が新しいオブジェクトとの通信に後で使用するインターフェイスの識別子への参照(通常は IID_IOleObject。OLE ヘッダーで IOleObject のインターフェイス ID として定義されています)。
renderopt	DWORD	in	新しく作成されるオブジェクトが持つべき、ローカルにキャッシュされた描画機能またはデータ取得機能を示す、列挙型 OLERENDER の値。選択した OLERENDER の値は、lpFormatEtc パラメーターに指定可能な値に影響します。
lpFormatEtc	FORMATETC*	in	renderopt の値として使用される OLERENDER フラグに応じて、FORMATETC 列挙値のいずれかへのポインター。制限事項については OLERENDER 列挙型も参照してください。
pClientSite	IOleClientSite*	in	IOleClientSite のインスタンスへのポインター。これは、オブジェクトがコンテナーにサービスを要求する際の主要なインターフェイスです。このパラメーターには NULL を指定できます。
pStg	IStorage*	in	ストレージオブジェクト上の IStorage インターフェイスへのポインター。このパラメーターに NULL を指定することはできません。
ppvObj	void**	out	riid で要求されたインターフェイスポインターを受け取るポインター変数のアドレス。正常に復帰すると、*ppvObj には新しく作成されたオブジェクト上の、要求されたインターフェイスポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

OleCreateFromFile 関数 (ole2.h) は、指定された名前のファイルの内容から埋め込みオブジェクトを作成します。

戻り値

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

戻り値	説明
STG_E_FILENOTFOUND	ファイルがバインドされていません。
OLE_E_CANT_BINDTOSOURCE	ソースにバインドできません。
STG_E_MEDIUMFULL	媒体が満杯です。
DV_E_TYMED	無効な TYMED です。
DV_E_LINDEX	無効な LINDEX です。
DV_E_FORMATETC	無効な FORMATETC 構造体です。

解説(Remarks)

OleCreateFromFile 関数は、指定された名前のファイルの内容から新しい埋め込みオブジェクトを作成します。登録データベース内の ProgID に PackageOnFileDrop キーが含まれている場合は、パッケージを作成します。含まれていない場合、この関数は GetClassFile 関数を呼び出して lpszFileName パラメーターに関連付けられた CLSID を取得し、その CLSID に関連付けられた OLE 2 埋め込みオブジェクトを作成します。OleCreateFromFile の rclsid パラメーターは常に無視されるため、CLSID_NULL に設定する必要があります。

他の OleCreateXxx 関数と同様に、新しく作成されたオブジェクトは編集のためにユーザーに表示されません。表示するには DoVerb 操作が必要です。これはファイルの挿入操作を実装するために使用されます。

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

各言語での呼び出し定義

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

HRESULT OleCreateFromFile(
    const GUID* rclsid,
    LPCWSTR lpszFileName,
    const GUID* riid,
    DWORD renderopt,
    FORMATETC* lpFormatEtc,
    IOleClientSite* pClientSite,
    IStorage* pStg,
    void** ppvObj
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleCreateFromFile(
    ref Guid rclsid,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] string lpszFileName,   // LPCWSTR
    ref Guid riid,   // GUID*
    uint renderopt,   // DWORD
    IntPtr lpFormatEtc,   // FORMATETC*
    IntPtr pClientSite,   // IOleClientSite*
    IntPtr pStg,   // IStorage*
    IntPtr ppvObj   // void** out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleCreateFromFile(
    ByRef rclsid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> lpszFileName As String,   ' LPCWSTR
    ByRef riid As Guid,   ' GUID*
    renderopt As UInteger,   ' DWORD
    lpFormatEtc As IntPtr,   ' FORMATETC*
    pClientSite As IntPtr,   ' IOleClientSite*
    pStg As IntPtr,   ' IStorage*
    ppvObj As IntPtr   ' void** out
) As Integer
End Function

' rclsid : GUID*
' lpszFileName : LPCWSTR
' riid : GUID*
' renderopt : DWORD
' lpFormatEtc : FORMATETC*
' pClientSite : IOleClientSite*
' pStg : IStorage*
' ppvObj : void** out
Declare PtrSafe Function OleCreateFromFile Lib "ole32" ( _
    ByVal rclsid As LongPtr, _
    ByVal lpszFileName As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal renderopt As Long, _
    ByVal lpFormatEtc 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

OleCreateFromFile = ctypes.windll.ole32.OleCreateFromFile
OleCreateFromFile.restype = ctypes.c_int
OleCreateFromFile.argtypes = [
    ctypes.c_void_p,  # rclsid : GUID*
    wintypes.LPCWSTR,  # lpszFileName : LPCWSTR
    ctypes.c_void_p,  # riid : GUID*
    wintypes.DWORD,  # renderopt : DWORD
    ctypes.c_void_p,  # lpFormatEtc : 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')
OleCreateFromFile = Fiddle::Function.new(
  lib['OleCreateFromFile'],
  [
    Fiddle::TYPE_VOIDP,  # rclsid : GUID*
    Fiddle::TYPE_VOIDP,  # lpszFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    -Fiddle::TYPE_INT,  # renderopt : DWORD
    Fiddle::TYPE_VOIDP,  # lpFormatEtc : 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 OleCreateFromFile(
        rclsid: *const GUID,  // GUID*
        lpszFileName: *const u16,  // LPCWSTR
        riid: *const GUID,  // GUID*
        renderopt: u32,  // DWORD
        lpFormatEtc: *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 OleCreateFromFile(ref Guid rclsid, [MarshalAs(UnmanagedType.LPWStr)] string lpszFileName, ref Guid riid, uint renderopt, IntPtr lpFormatEtc, IntPtr pClientSite, IntPtr pStg, IntPtr ppvObj);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleCreateFromFile' -Namespace Win32 -PassThru
# $api::OleCreateFromFile(rclsid, lpszFileName, riid, renderopt, lpFormatEtc, pClientSite, pStg, ppvObj)

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

出力引数:

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