ICLRMetaHostインスタンスを取得

まずはICLRMetaHostインターフェイスのインスタンスを取得します。このインターフェイスは、システムにインストールされているランタイムを列挙し、指定バージョンに対応するランタイムの操作を行うためのインスタンスを取得する機能を提供しています。

ICLRMetaHostのインスタンスは、.NET Framework バージョン4以上であれば、「mscoree.dll」がエクスポートしている関数「CLRCreateInstance」経由で取得します。

※ バージョン4未満の場合は「補足: 旧バージョンの場合」をご覧ください。

[C/C++]

// (参考のため紹介: 宣言は metahost.h に記述されています)
STDAPI CLRCreateInstance(REFCLSID clsid, REFIID riid, LPVOID* ppInterface);

[VBA 7.0]

Declare PtrSafe Function CLRCreateInstance Lib "mscoree.dll" _
    (ByRef rclsid As Any, ByRef riid As Any, ByRef ppvInterface As IUnknown) As Long

※ 簡単のためGUID系の型を「Any」で定義し、「g(0 To 3) As Long」などの配列も指定できるようにしています。また、ppInterfaceは「IUnknown*」(およびその派生)以外のデータが出力されることは無いため、明示させています。

ICLRMetaHostのインスタンスを得るには、この関数にCLSIDとして「{9280188D-0E8E-4867-B30C-7FA83884E8DE}」(CLSID_CLRMetaHost)、IIDに「{D332DB9E-B9B3-4125-8207-A14884F53216}」(IID_ICLRMetaHost)を指定します。

[VBA 7.0]

    Dim g(0 To 3) As Long
    Dim g2(0 To 3) As Long
    Dim pMetaHost As IUnknown, hr As Long
    Call ParseGUID(g, "{9280188D-0E8E-4867-B30C-7FA83884E8DE}") ' CLSID_CLRMetaHost
    Call ParseGUID(g2, "{D332DB9E-B9B3-4125-8207-A14884F53216}") ' IID_ICLRMetaHost
    hr = CLRCreateInstance(g(0), g2(0), pMetaHost)
    ' (HRESULTは Err.Raise にそのまま渡すことで対応するエラーを発生させることが可能)
    If hr < 0 Then Call Err.Raise(hr)

ICLRMetaHostのメソッドを利用するために…

次はICLRMetaHostにある「GetRuntime」メソッドを呼び出してインスタンスを取得したいところですが、「参照設定」で追加できる「Common Language Runtime Execution Engine」(mscoree.dll 用のタイプライブラリ)には「ICLRMetaHost」(あるいは「CLRMetaHost」)が含まれていません。ICLRMetaHostはIUnknownから直接派生したインターフェイスであるため、型定義の無い状況でメソッドを呼び出すには仮想関数テーブルをうまく用いるしかありません。

仮想関数テーブルを用いたメソッド呼び出しは「VB で機械語を実行する」のように機械語を記述して無理やり呼び出すこともできなくはないですが、より容易に呼び出す方法として oleaut32.dll にある「DispCallFunc」関数を用いることができます。ここではVB向けに以下のように定義します。

[VBA 7.0]

Declare PtrSafe Function DispCallFunc Lib "oleaut32.dll" _
    (ByVal pvInstance As LongPtr, _
    ByVal oVft As LongPtr, _
    ByVal cc As Long, _
    ByVal vtReturn As Integer, _
    ByVal cActuals As Long, _
    ByRef prgvt As Integer, _
    ByRef prgpvarg As LongPtr, _
    ByRef pvargResult As Variant) As Long

[2019/04/25 追記] DispCallFunc の定義が誤っていたため修正しました。(GitHub Issue #1 での指摘より)

IUnknown ベースのインスタンスに対して仮想関数を呼び出したい場合は、「pvInstance」にそのインスタンスのポインター(ObjPtrで取得)、「oVft」に「仮想関数テーブルのインデックス番号にポインターのサイズをかけたもの(= テーブルにおけるバイトオフセット)」を指定し、残りの引数にそのメソッドの定義に基づいた情報とパラメーターを入れていきます。

※ 仮想関数テーブルのインデックス値は、C/C++向けのヘッダーファイル等で調べる必要があります。

この関数を直接利用するのは少々面倒であるため、以下のようなラッパー関数「VBCallAbsoluteObject」を定義してそれを用いることとします。

[VBA 7.0]

' Object に対して IndexForVftable に対応するメソッドを呼び出します。
' - RetTypeにはメソッド本来の戻り値の型を VbVarType (または VT_*)で指定します。
' - Arguments にはメソッドの引数を指定します。
'   指定時の型がそのまま呼び出し時の変換のヒントとして用いられるため、
'   必要に応じて CLng などの明示的な型変換を行ってください。
Public Function VBCallAbsoluteObject(ByVal Object As IUnknown, _
    ByVal IndexForVftable As Integer, _
    ByVal RetType As VbVarType, _
    ParamArray Arguments() As Variant) As Variant
    ' (具体的な実装はページの最後をご覧ください。)
End Function

CLRバージョンを指定してICLRRuntimeInfoインスタンスを取得

前述の機能によりICLRMetaHostのメソッドを自由に呼び出せるようになったため、本題に戻って「ICLRRuntimeInfo」のインスタンスを取得します。ICLRMetaHost::GetRuntime にはCLRのバージョンを引数として受け取るため、今回は「v4.0.30319」を用いて呼び出すこととします。なお、「GetRuntime」は仮想関数テーブルのインデックス番号が「3」となります。

※ バージョン文字列は「v」で始まる .NET のバージョンなどを指定しますが、システムで実際に利用できるバージョンはICLRMetaHostのEnumerateInstalledRuntimesメソッドなどで確認することができます。ここではその説明は省略します。

[VBA 7.0]

' ※ 以下のコードは pMetaHost 取得コードの続きです。

    ' CLRのバージョンを持つ変数
    ' .NET 4系の「v4.0.30319」を用いることとする
    Dim Version As String
    Version = "v4.0.30319"

    Dim pRuntimeInfo As IUnknown
    Call ParseGUID(g, "{BD39D1D2-BA2F-486A-89B0-B4B0CB466891}") ' IID_ICLRRuntimeInfo
    ' ICLRMetaHost::GetRuntime(LPCWSTR, REFIID, void**) [vftable index = 3]
    ' 第1引数の文字列はポインターとして渡す
    ' 第3引数は出力先を pRuntimeInfo とするために VarPtr で渡す
    hr = VBCallAbsoluteObject(pMetaHost, 3, vbLong, _
        StrPtr(Version), VarPtr(g(0)), VarPtr(pRuntimeInfo))
    ' pMetaHost は使わないので解放しておく(任意)
    ' ※ Nothing とすることで半明示的に Release できる
    Set pMetaHost = Nothing
    If hr < 0 Then Call Err.Raise(hr)

ランタイムのホストインスタンスを取得

CLRの情報を提供するICLRRuntimeInfoのインスタンスを取得できたら、ランタイムのホストとして機能を提供する「ICorRuntimeHost」インターフェイスのインスタンスを取得します。これを得ることで、アセンブリのロードなどCLRの各種機能を扱うことができるようになります。

ICorRuntimeHostインターフェイスのインスタンスを取得するには、ICLRRuntimeInfo::GetInterface メソッドを利用します。「GetInterface」は仮想関数テーブルのインデックス番号が「9」となります。

また、これによって得られたインスタンスは、先でも触れていた「参照設定」で「mscoree.dll」を読み込むと使用できるタイプライブラリ「Common Language Runtime Execution Engine」の、「mscoree.CorRuntimeHost」クラスのインスタンスとして扱うことができます。こちらは型定義があり一部を除いてメソッドを呼び出すことができるため、(事前にIDEにて「参照設定」を追加した上で)「CorRuntimeHost」に変換しておきます。

※ タイプライブラリが一覧にない場合は、「<フレームワークのディレクトリ>\mscoree.tlb」(TLBファイル)を手動で読み込みます。「<フレームワークのディレクトリ>」は「%SystemRoot%\Microsoft.NET\Framework\v4.0.30319」(64ビット版の場合は「%SystemRoot%\Microsoft.NET\Framework64\v4.0.30319」)などといった場所になります。

[VBA 7.0]

' ※ 以下のコードは pRuntimeInfo 取得コードの続きです。

    Dim pCorRuntimeHost As IUnknown
    ' ICLRRuntimeInfo::GetInterface(REFCLSID, REFIID, void**) [vftable index = 9]
    Call ParseGUID(g, "{CB2F6723-AB3A-11D2-9C40-00C04FA30A3E}") ' CLSID_CorRuntimeHost
    Call ParseGUID(g2, "{CB2F6722-AB3A-11D2-9C40-00C04FA30A3E}") ' IID_ICorRuntimeHost
    ' 第3引数は出力先を pCorRuntimeHost とするために VarPtr で渡す
    hr = VBCallAbsoluteObject(pRuntimeInfo, 9, vbLong, _
        VarPtr(g(0)), VarPtr(g2(0)), VarPtr(pCorRuntimeHost))
    Set pRuntimeInfo = Nothing
    If hr < 0 Then Call Err.Raise(hr)
    ' クラス mscoree.CorRuntimeHost のインターフェイスは ICorRuntimeHost と一致するため、
    ' より容易にVB上で扱えるように型変換を行う
    Dim host As mscoree.CorRuntimeHost
    Set host = pCorRuntimeHost

以上により、「host」変数にホストインスタンスが代入されたため、これを起点にCLRの機能を利用していきます。

※ なお、外部アセンブリを実行するのみである場合は「ICLRRuntimeHost」インターフェイスのインスタンスを取得する方が容易に実現可能です。上記のGetInterface呼び出しにおいて「CLSID_CLRRuntimeHost = {90F1A06E-7712-4762-86B5-7A5EBA6BDB02}」「IID_ICLRRuntimeHost = {90F1A06C-7712-4762-86B5-7A5EBA6BDB02}」を用いてインスタンスを取得します。

CLR利用の開始と終了

CorRuntimeHostクラスには「Start」メソッドと「Stop」メソッドがあり、明示的にCLRを起動・終了することができます。ヘルプには「通常では不要」とあり、特にStartについては何かしらの機能を利用した段階で自動起動されますが、プログラムとして生成されていないVBアプリケーションでの実行やVBAでは同じプロセス上でプログラムの起動終了が行われるため、予期しない動作を防ぐ目的で明示的に呼び出しておきます。

なお、Stopメソッドは必ず呼び出すようにしてください。(VBAの場合、Stopをし忘れるとVBAのホストプログラム終了時に異常終了する可能性があります。)

※ 必ず終了できるようにするために、「VBAの終了タイミングと終了処理の記述」で紹介している方法の利用も検討してください。

[VBA 7.0]

' ※ 以下のコードは CorRuntimeHost 取得コードの続きです。

    ' 主に host 取得直後に実行
    Call host.Start

    ...

    ' 主にすべての処理が終わった段階で実行
    Call host.Stop

CLR初期化のまとめ

ここまでの処理を、以下のように関数にまとめました(一部コメントは省略しています)。この関数「CreateCorRuntimeHost」を呼び出すことでホストインスタンスを得ることができます。

※ なお、mscoree.CorRuntimeHost はコクラスであるため New 演算子でも作成することができますが、そのインスタンスを利用した場合一部CLR機能の呼び出し時に内部例外が発生する場合があるのを確認しており、またバージョン指定もできないため、利用しない方が良いと思われます。

[VBA 7.0]

' バージョン文字列から CorRuntimeHost オブジェクトを作成します。
' - Version: 「v4.0.30319」のように「v」で始まるバージョン文字列
Public Function CreateCorRuntimeHost(ByVal Version As String) As mscoree.CorRuntimeHost
    Dim g(0 To 3) As Long
    Dim g2(0 To 3) As Long
    Dim pMetaHost As IUnknown, hr As Long
    Call ParseGUID(g, "{9280188D-0E8E-4867-B30C-7FA83884E8DE}") ' CLSID_CLRMetaHost
    Call ParseGUID(g2, "{D332DB9E-B9B3-4125-8207-A14884F53216}") ' IID_ICLRMetaHost
    hr = CLRCreateInstance(g(0), g2(0), pMetaHost)
    If hr < 0 Then Call Err.Raise(hr)

    Dim pRuntimeInfo As IUnknown
    Call ParseGUID(g, "{BD39D1D2-BA2F-486A-89B0-B4B0CB466891}") ' IID_ICLRRuntimeInfo
    ' ICLRMetaHost::GetRuntime(LPCWSTR, REFIID, void**) [vftable index = 3]
    hr = VBCallAbsoluteObject(pMetaHost, 3, vbLong, _
        StrPtr(Version), VarPtr(g(0)), VarPtr(pRuntimeInfo))
    Set pMetaHost = Nothing
    If hr < 0 Then Call Err.Raise(hr)

    Dim pCorRuntimeHost As IUnknown
    ' ICLRRuntimeInfo::GetInterface(REFCLSID, REFIID, void**) [vftable index = 9]
    Call ParseGUID(g, "{CB2F6723-AB3A-11D2-9C40-00C04FA30A3E}") ' CLSID_CorRuntimeHost
    Call ParseGUID(g2, "{CB2F6722-AB3A-11D2-9C40-00C04FA30A3E}") ' IID_ICorRuntimeHost
    hr = VBCallAbsoluteObject(pRuntimeInfo, 9, vbLong, _
        VarPtr(g(0)), VarPtr(g2(0)), VarPtr(pCorRuntimeHost))
    Set pRuntimeInfo = Nothing
    If hr < 0 Then Call Err.Raise(hr)
    Set CreateCorRuntimeHost = pCorRuntimeHost
End Function

補足: 旧バージョンの場合

.NET Framework バージョン4未満の場合はCLRCreateInstance関数を利用できませんが、代わりにCorBindToRuntimeEx関数を利用することができます。この関数を利用すると、指定したバージョンに対応するICorRuntimeHostインターフェイスのインスタンスを取得することができます。

なお、この関数の利用は前述したインスタンス取得方法より非常に容易ですが、「.NET Framework 4 以降ではdeprecated」となっている点に注意が必要です。

[VBA 7.0]

Private Declare PtrSafe Function CorBindToRuntimeEx Lib "mscoree.dll" _
    (ByVal pwszVersion As LongPtr, ByVal pwszBuildFlavor As LongPtr, _
    ByVal startupFlags As Long, ByRef rclsid As Any, _
    ByRef riid As Any, ByRef ppv As Any) As Long

' 前述の「CreateCorRuntimeHost」と同じように利用できます。
Public Function CreateCorRuntimeHostOld(ByVal Version As String) As mscoree.CorRuntimeHost
    Dim flavor As String
    Dim g(0 To 3) As Long
    Dim g2(0 To 3) As Long
    Dim pCorRuntimeHost As IUnknown, hr As Long
    Call ParseGUID(g, "{CB2F6723-AB3A-11D2-9C40-00C04FA30A3E}") ' CLSID_CorRuntimeHost
    Call ParseGUID(g2, "{CB2F6722-AB3A-11D2-9C40-00C04FA30A3E}") ' IID_ICorRuntimeHost

    ' ワークステーションビルド用を利用する(サーバービルド用の場合は "svr")
    ' (StrPtrを用いるため、意図せず破棄されないように一旦変数に展開)
    flavor = "wks"
    hr = CorBindToRuntimeEx(StrPtr(Version), StrPtr(flavor), 0, _
        g(0), g2(0), pCorRuntimeHost)
    If hr < 0 Then Call Err.Raise(hr)
    Set CreateCorRuntimeHostOld = pCorRuntimeHost
End Function

既定のドメインの取得

CLRがロードされると「既定のドメイン」が必ず作成されているため、これを利用することができます。既定のドメインを取得するには「GetDefaultDomain」メソッドを利用します。

[VBA 7.0]

' 「host」は初期化済み・開始済みの mscoree.CorRuntimeHost オブジェクトとします。

    Dim pUnkDomain As IUnknown
    Dim domain As mscorlib.AppDomain
    ' 引数は出力引数であり、IUnknownのポインターが必要なので pUnkDomain を渡す
    ' (直接 domain 変数を指定しても可)
    Call host.GetDefaultDomain(pUnkDomain)
    Set domain = pUnkDomain

新規ドメインの作成

一方で新たにドメインを作成することもできます。今回のような目的では必要ではありませんが、アセンブリの実行環境の分離、デバッグ用に分かりやすい名前の付与、およびセキュリティを考慮した制限の追加、などの目的で利用できます。新たにドメインを作成するには「CreateDomain」メソッドを利用します。

なお、VBA上で実行する場合は、CLR実行環境の起動と終了(「ドメインのアンロード」を参照)を明確にするために、既定のドメインの利用ではなく新たなドメインの作成を強く推奨します。既定のドメインを用いた場合、CLRの呼び出し状況によってはVBAをホストするアプリケーションの終了時に異常終了する場合があります。(VB6.0系で動作させる場合も開発環境での確認を考慮すると作成した方が良いと考えられます。)

※ この他に mscorlib.AppDomainSetup (System.AppDomainSetup) を利用してドメイン初期化時の情報を与える「CreateDomainEx」メソッドもあります。用途に応じて使い分けてください。

[VBA 7.0]

' 「host」は初期化済み・開始済みの mscoree.CorRuntimeHost オブジェクトとします。

    Dim pUnkDomain As IUnknown
    Dim domain As mscorlib.AppDomain
    ' 適当なドメイン名を付けてドメインを作成
    ' 第3引数は出力引数であり、IUnknownのポインターが必要なので pUnkDomain を渡す
    ' (直接 domain 変数を指定しても可)
    Call host.CreateDomain("VB2CLRTest", Nothing, pUnkDomain)
    Set domain = pUnkDomain

ドメインのアンロード

CreateDomain で作成したドメインは以下のようにアンロードすることができます。一時的な目的で作成したドメインが不要になった場合は明示的にアンロードしておきます。

※ ドメインのアンロードが明示的に行われなくても、ホストの Stop メソッドが呼び出された場合すべての処理が終了します。

[VBA 7.0]

    Set domain = Nothing
    Call host.UnloadDomain(pUnkDomain)
    Set pUnkDomain = Nothing