【ExcelVBA】ExcelからC#で作成したDLLを呼び出す方法（COM経由／COMインターフェース）

2022-02-18 2023-05-15

tasu

1 概要
2 手順
- 2.1 DLL側作業
- 2.2 Excel側作業
3 【手順１】DLLプロジェクト作成
4 【手順２】DLLプロジェクト設定
5 【手順３】DLL実装
6 【手順４】DLL登録
7 【手順５】参照設定
8 【手順６】DLL呼出
9 外部リンク
- 9.1 関連

概要

本記事では、Excel側のVBAからC#で作成したDLLの関数を呼び出す方法を紹介します。

VBAでごりごりコードを書く作業が苦手（苦痛）且つ、C#での開発に慣れている方は、今回の記事が参考になるのではないかと思います。

今回は、C#のDLLに指定ディレクトリ以下のファイルリストを取得する関数を実装してみたいと思います。

手順

DLL側作業

DLLプロジェクト作成…C#でクラスライブラリプロジェクトを作成します。
DLLプロジェクト設定…COM運用できるようにプロジェクトを設定します。
DLL実装…DLLに関数を実装します。
DLL登録…DLLをシステムに登録します。

Excel側作業

参照設定…Excel側作業：Excelの参照設定にDLLを追加します。
DLL呼出…Excel側作業：ExcelからDLLを呼び出します。

【手順１】DLLプロジェクト作成

VisualStudio起動

プロジェクト作成ダイアログ起動

上部メニュー⇒「File」⇒「New」⇒「Project」

クラスライブラリ選択

左部ツリー⇒「Installed」⇒「Templates」⇒「Visual C#」

中部リスト⇒「Class Library」

プロジェクト名決定

ダイアログ下部「Name」にプロジェクト名を入力します。

ダイアログ下部「OK」ボタンをクリックします。

【手順２】DLLプロジェクト設定

プロジェクト設定画面起動

上部メニュー⇒「Project」⇒「ExcelAddin Properties」

COM設定１

プロジェクト設定画面の左部から「Application」を選択します。

プロジェクト設定画面の右部から「Assembly Information...」ボタンをクリックします。

Assembly Information 下部「Make Assembly COM-Visible」をチェックし、「OK」ボタンをクリックします。

COM設定２

プロジェクト設定画面の左部「Build」を選択します。

プロジェクト設定画面の下部「Register for COM interop」をチェックします。

プロジェクト設定保存

[Ctrl]+[S]キーで設定を保存します。又は、[Alt]+[B],[B]キーでビルドを行います。

【手順３】DLL実装

インターフェースクラス作成

下記コード、IExcelAddinクラスが該当します。
外部に公開する関数のインターフェースを定義します。
クラス属性「ComVisible」に「true」を設定し、このクラスをCOM経由で公開します。

実装クラス作成

下記コード、ExcelAddinクラスが該当します。
外部に公開する関数の実装を行います。
IExcelAddinクラスを継承します。

コード

using System.Linq;
using System.IO;
using System.Runtime.InteropServices;

namespace ExcelAddin
{
    [ComVisible(true)]
    public interface IExcelAddin
    {
        int GetFileList(string searchPath, string searchPattern, ref string[] fileList);
    }
    [ClassInterface(ClassInterfaceType.None)]
    public class ExcelAddin : IExcelAddin
    {
        /// <summary>
        /// ファイルリスト取得(サブディレクトリ含む)
        /// </summary>
        /// <param name="searchPath">検索パス</param>
        /// <param name="searchPattern">検索パターン(ワイルドカード)</param>
        /// <param name="fileList">取得ファイルリスト</param>
        /// <returns>取得ファイルリスト個数</returns>
        public int GetFileList(string searchPath, string searchPattern, ref string[] fileList)
        {
            // get file list
            fileList = Directory.GetFiles(searchPath, searchPattern, SearchOption.AllDirectories);
            // get file count
            int fileCount = 0;
            fileCount = fileList.Count();
            return fileCount;
        }
    }
}

【手順４】DLL登録

作成したDLLをCOMコンポーネントとしてシステムに登録します。

実行ダイアログ起動

[Win]+[R]キーで実行ダイアログを起動します。

管理者権限でコマンドプロンプト起動

「cmd」と入力します。

[Shift]+[Ctrl]+[Enter]キーを押下する。

DLL登録

以下から登録コマンドを１つ（下記注意参照）実行し、DLLをシステムに登録します。

コード

"C:\Windows\Microsoft.NET\Framework\v2.0.50727\RegAsm.exe" "C:\Work\ExcelAddin.dll" /tlb /codebase
"C:\Windows\Microsoft.NET\Framework\v4.0.30319\RegAsm.exe" "C:\Work\ExcelAddin.dll" /tlb /codebase
"C:\Windows\Microsoft.NET\Framework64\v2.0.50727\RegAsm.exe" "C:\Work\ExcelAddin.dll" /tlb /codebase
"C:\Windows\Microsoft.NET\Framework64\v4.0.30319\RegAsm.exe" "C:\Work\ExcelAddin.dll" /tlb /codebase

注意

プラットフォームと.NETFrameworkバージョンに対応するRegAsm.exeを使用してください。
- プラットフォームが32bitの場合　⇒　パス"Framework"
- プラットフォームが64bitの場合　⇒　パス"Framework64"
- .NETFrameworkのバージョンが4未満の場合　⇒　パス"v2.0.50727"
- .NETFrameworkのバージョンが4以上の場合　⇒　パス"v4.0.30319"
上記コマンドの"C:\Work\ExcelAddin.dll"部分は、自分の環境に合わせ変更してください。

DLL登録解除

この操作は、DLLが不要になった場合のみ実行してください。

以下から解除コマンドを１つ（下記注意参照）実行し、DLLをシステムから削除します。

コード

"C:\Windows\Microsoft.NET\Framework\v2.0.50727\RegAsm.exe" "C:\Work\ExcelAddin.dll" /tlb /u
"C:\Windows\Microsoft.NET\Framework\v4.0.30319\RegAsm.exe" "C:\Work\ExcelAddin.dll" /tlb /u
"C:\Windows\Microsoft.NET\Framework64\v2.0.50727\RegAsm.exe" "C:\Work\ExcelAddin.dll" /tlb /u
"C:\Windows\Microsoft.NET\Framework64\v4.0.30319\RegAsm.exe" "C:\Work\ExcelAddin.dll" /tlb /u

注意

プラットフォームと.NETFrameworkバージョンに対応するRegAsm.exeを使用してください。
上記コマンドの"C:\Work\ExcelAddin.dll"部分は、自分の環境に合わせ変更してください。

【手順５】参照設定

Excel起動

VBA開発環境起動

Excel上部メニュー⇒「開発」⇒「Visual Basic」をクリックします。

参照設定画面起動

VBA上部メニュー⇒「ツール」⇒「参照設定」をクリックします。

DLL参照追加

左部リスト⇒「ExcelAddin」チェック⇒「OK」ボタンをクリックします。

※Excelに作成したDLLの参照を追加します。

【手順６】DLL呼出

標準モジュール作成

VBA上部メニュー⇒「挿入」⇒「標準モジュール」をクリックします。

呼出コード実装

作成した標準モジュールに以下のコードを実装します。

コード

Sub Function1()
    
    Dim searchPath As String
    Dim searchPattern As String
    Dim fileList() As String
    Dim fileCount As Integer
    
    'DLLロード
    Dim addin As ExcelAddin.ExcelAddin
    Set addin = New ExcelAddin.ExcelAddin
    
    'ファイルリスト取得
    searchPath = "C:\Temp"  '検索パス
    searchPattern = "*.*"   '検索パターン(ワイルドカード)
    fileCount = addin.GetFileList(searchPath, searchPattern, fileList)
    
    'ファイルリスト出力
    For Each file In fileList
        Debug.Print (file)
    Next
    
End Sub