COMインターフェイスを通したAsprovaの機能の拡張 【イベント発生のアクセスポイントで実行させるプラグインキー（Hook）】

市販のERPシステムやAPSシステムでは、ソースコードは公開しない代わりに、COMインターフェイスを公開し、Standard EXEファイルやプラグイン（DLL）で機能を拡張することができるようにしています。
Wordpressのプラグインと同じようにAsprovaのプラグインも単体では動作せず、本体のソフトウェアに追加しなければ機能しません。

Asprova本体は、イベントの発生タイミングにプラグインを実行させるためのHookを用意しており、このイベントを表すアクセスポイントであるプラグインキーが、Wordpressのdo_actionフックまたはapply_filtersフックに該当します。

COMインターフェイスとは

AsprovaはCOM (Component Object Model)で内部のデータや処理内容を公開する仕組みをもっており、プラグイン（ActiveX DLLファイル：Asprovaから関数呼び出し）やオートメーションクライアント（Standard EXEファイル：外部プログラムからAsprovaにアクセス）から機能追加することができます。

DLLファイルはAsprovaのEXEと同じフォルダに配置され、起動時にAsprovaに自動的に読み込まれます。

DLLはAsprovaの内部コマンドとして登録されますので、ユーザー定義メニューにくっつけてAsprovaからDLLを呼び出しますが、EXEの場合はプロジェクトファイルの名前を指定して開くことでアクティブなプロジェクトを取得します。

DLLの配置場所

DLLは起動するEXEから見て以下の場所に配置する必要があります。

開発環境の参照設定（プラグイン内からAsprovaのライブラリを使用）

参照設定はGUIを持たないActiveXオブジェクトのタイプライブラリをプロジェクトで利用するためにプロジェクトファイル（.vbpファイル）内に保存され、プラグイン（プロジェクトファイルをコンパイルしたDLL）からCOMインターフェイスを通してAsprovaのライブラリにアクセスします。

参照設定によりDim変数宣言の際にそのオブジェクトの型を使用することが出来たり、new 演算子でインスタンスを生成することが出来るようになります。

プラグインからAsprovaのライブラリを参照する場合、下記の2つのAsprovaのクラスライブラリを開発環境の参照設定から登録します。

プラグインのプロジェクトファイルの構成

プラグインの場合、Asprovaから呼び出す関数をASDefaultクラスのAutoRegistrationメソッドに登録します。

Asprovaの「プラグイン情報」にプラグインとして登録しておけばAsprova起動時にAutoRegistration関数が自動的に呼ばれ、プロジェクトオブジェクト内に実装されます。

Standard EXE（オートメーションクライアント）の場合はASDefaultクラスは必要ありません。

Asprovaのプラグインマネージャー（プラグイン登録関数）のAddASPlugInメソッドに4つの引数を渡すことによりプラグインを登録しますが、その内容は「自分はFactoryというプロジェクトで、OvertimeというクラスにAddOverTimeというメソッド（エントリ関数）を用意しているから、プラグインキーKeyHookGenericのタイミングで呼んでください」というものです。

プラグインキー（アクセスポイント）に対応するフックと関数のマッピング

Asprovaはあるイベントごとにプラグインを実行させるためのフックを設けています。

この各イベントを表すアクセスポイントをプラグインキーと呼び、例えばKeyHookGenericは「コマンドの追加」、つまり追加したコマンドが起動するタイミングのアクセスポイントで、コマンドを実行することによりプラグインを実行させます。

Option Explicit
Public Function AutoRegistration(plugInManager As ASPPlugInManager, module As ASPModule) As Boolean
    'このモジュールのコメントを設定します
    module.Comment = "APS Extended Functionality PlugIns (VB)"
    'プラグインオブジェクトを保持する変数を定義します
    Dim plugIn As ASPPlugIn
    ' ---------------------------------------------------------------------------------------------
    'プラグインマネージャを呼び出し、新しいプラグインを登録します。呼び出しメソッド名はAddASPlugIn です
    ' 第1Param:プラグイン表示名
    ' 第2Param:プラグインが実装されているモジュール及びクラスを表すProgID
    ' 第3Param:プラグインのエントリ関数名（呼び出し名）
    ' 第4Param:プラグインが使用されるコンテキストを表すキー名

    '(1)オーバータイムや土日残業を自動的に計算しカレンダーテーブルにセットする
    Set plugIn = plugInManager.AddASPlugIn("オーバータイムを残業と土曜出勤に組み込む", "Factory1.OverTime", "AddOverTime", ASPlugInKeyName.KeyHookGeneric)
    'このプラグインにコメント等などを設定します。

    plugIn.Comment = "オーバータイムを平日残業2時間と土曜2シフト出勤に割り振る。"
    'プラグイン呼び出し順(同一プラグインキーのプラグインが複数あったときのため)
    plugIn.Order = 1
    '自動登録が正常に行われたという事でTrue を返します。
    AutoRegistration = True
End Function

Asprovaは起動時にプラグインを自動的に読み込むと、内部コマンドのプラグインに「エントリ関数の表示名」（プラグインマネージャ呼び出し時の第一引数）を表示させます。

プラグインの中からAsprovaのプラグインマネージャーを呼び出し4つの引数を渡すことによりプラグインを登録します。

COMポート（communication port）のポートと同じ考え方

ついでに言うとCOMポートとCOMインターフェイスのCOMは別物ですが、外部インターフェイスとの標準規格という意味ではCOMポートもCOMインターフェイスも同じもです。

ソフトウェアやハードウェアには、外部とデータを入出力するためにデータの受け渡しの方法を標準化したインターフェース（ポート）を持っています。例えばPOPとSMTPサーバーのポート、DBに接続するときのポートはいずれもTCP/IPのポートです。

標準的なパソコンは、キーボードなどの周辺機器を接続するためのインターフェースとしてPS/2ポートやUSBポート、LANポート(Ethernetポート)などを備えています。

ソフトウェアの場合、外部の装置や通信ネットワークとのデータの送受信を標準的な方法で統一的に扱う方法がOSなどによって提供されており、通信相手などを識別するのにポートが使われます。

Windowsではモデムやプリンタ、イメージスキャナなどにアプリケーションソフトが統一的な方法でアクセスできるよう、入出力方式を統一した「COMポート」という仕組みが提供されており、アプリケーションソフトは自分の対象とする機器がどのCOMポートに接続されているかを知るだけで、当該機器との入出力が取り扱えるようになります。

例えばUSBバーコードを接続する場合にはCOM13が割り当てられますが、物理的にPCには13個もインターフェイスは存在しないのでCOM13というポートはあくまで仮想的なものです。

TCP/IPを利用したネットワーク通信では、通信機器や個々のコンピュータの持つIPアドレスの下に設けられた補助アドレスとして、0から65535までの「ポート番号」が使われます。

これにより、1台のコンピュータで複数のサービスを提供したり、複数のコンピュータと同時に通信できるようになっています。単に「ポート」といった場合には、このTCP/IPのポート番号を指すことも多いです。