ホーム › System.Ole › OleCreateDefaultHandler

OleCreateDefaultHandler

関数

OLEオブジェクト用の既定のハンドラを作成する。

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

シグネチャ

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

HRESULT OleCreateDefaultHandler(
    const GUID* clsid,
    IUnknown* pUnkOuter,
    const GUID* riid,
    void** lplpObj
);

パラメーター

名前	型	方向	説明
clsid	GUID*	in	埋め込みオブジェクトが実行状態に入るときに読み込まれる OLE サーバーを識別する CLSID。
pUnkOuter	IUnknown*	in	ハンドラーを集約する場合は、制御側の IUnknown インターフェイスへのポインター。集約しない場合は NULL。
riid	GUID*	in	呼び出し元がハンドラーと通信するために使用するインターフェイス(通常は IID_IOleObject)の識別子への参照。
lplpObj	void**	out	riid で要求されたインターフェイスポインターを受け取るポインター変数のアドレス。正常に返ると、*ppvObj には、新しく作成されたハンドラー上の要求されたインターフェイスポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

既定の埋め込みハンドラーの新しいインスタンスを作成します。このインスタンスは、埋め込みオブジェクトが実行状態に入るときにローカルサーバーを作成するように初期化されます。

戻り値

この関数は、成功時に NOERROR を返し、標準の戻り値 E_OUTOFMEMORY をサポートします。

解説(Remarks)

OleCreateDefaultHandler は、既定の埋め込みハンドラーの新しいインスタンスを作成します。このインスタンスは、埋め込みオブジェクトが実行状態に入るときに clsid パラメーターで識別されるローカルサーバーを作成するように初期化されます。ハンドラーを作成していて、既定のハンドラーのサービスを使用したい場合は、OleCreateDefaultHandler を呼び出します。OLE は、オブジェクト作成呼び出しで指定された CLSID が登録されていない場合に、内部的にこの関数を呼び出すこともあります。

指定したクラスに専用のハンドラーがない場合、OleCreateDefaultHandler の呼び出しは、クラスコンテキストパラメーターに CLSCTX_INPROC_HANDLER の値を割り当てて CoCreateInstance 関数を呼び出した場合と同じ結果になります。

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

各言語での呼び出し定義

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

HRESULT OleCreateDefaultHandler(
    const GUID* clsid,
    IUnknown* pUnkOuter,
    const GUID* riid,
    void** lplpObj
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleCreateDefaultHandler(
    ref Guid clsid,   // GUID*
    IntPtr pUnkOuter,   // IUnknown*
    ref Guid riid,   // GUID*
    IntPtr lplpObj   // void** out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleCreateDefaultHandler(
    ByRef clsid As Guid,   ' GUID*
    pUnkOuter As IntPtr,   ' IUnknown*
    ByRef riid As Guid,   ' GUID*
    lplpObj As IntPtr   ' void** out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

OleCreateDefaultHandler = ctypes.windll.ole32.OleCreateDefaultHandler
OleCreateDefaultHandler.restype = ctypes.c_int
OleCreateDefaultHandler.argtypes = [
    ctypes.c_void_p,  # clsid : GUID*
    ctypes.c_void_p,  # pUnkOuter : IUnknown*
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # lplpObj : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleCreateDefaultHandler = Fiddle::Function.new(
  lib['OleCreateDefaultHandler'],
  [
    Fiddle::TYPE_VOIDP,  # clsid : GUID*
    Fiddle::TYPE_VOIDP,  # pUnkOuter : IUnknown*
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # lplpObj : void** out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleCreateDefaultHandler(ref Guid clsid, IntPtr pUnkOuter, ref Guid riid, IntPtr lplpObj);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleCreateDefaultHandler' -Namespace Win32 -PassThru
# $api::OleCreateDefaultHandler(clsid, pUnkOuter, riid, lplpObj)

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

出力引数:

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