API
API
以下のAPIを、「__stdcall（WINAPI）」呼び出し規約で定義してください。
| API名 | 機能 |
|---|---|
| UserCallOut_GetUserCfg | コールアウトカスタムパラメーター取得 |
| UserCallOut_SetUserCfg | コールアウトカスタムパラメーター設定 |
| UserCallOut_ChInit | チャンネル情報初期化 |
| UserCallOut_ChDeInit | チャンネル情報終了処理 |
| UserCallOut_MonStart | モニタ開始通知 |
| UserCallOut_CreMacDaPreFixReq | 送信MAC生成用プリフィックスデータ要求 |
| UserCallOut_CreMacDaPostFixReq | 送信MAC生成用ポストフィックスデータ要求 |
| UserCallOut_TruncatedFvReq | 切り出しFV要求 |
| UserCallOut_MacDaPreFixReq | 認証用MAC生成用プリフィックスデータ要求 |
| UserCallOut_MacDaPostFixReq | 認証用MAC生成用ポストフィックスデータ要求 |
| UserCallOut_AfterMacVerify | MAC生成結果通知 |
| UserCallOut_AfterTransMsg | MAC送信要求完了通知 |
| UserCallOut_MonStop | モニタ終了通知 |
各APIの詳細については、以下の形式で説明します。
なお、戻り値は全てのAPIで、DWORD型の「MPX_COUT_OK」（定数定義：エラーコード」参照）を返すようにしてください。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | <APIの型> <API名>（<引数>, …） | |||
| 引数 | <引数の型>(※1) | （引数名） | <in/out>(※2) | <引数の説明> |
| 機能 | <APIの機能の説明> | |||
| 呼出 | <APIが呼び出されるタイミング> | |||
| 補足 | <APIの補足説明> | |||
※1: 構造体にセットする値、またはセットされる値については、「構造体定義」を参照してください。
※2: 関数の呼び出し時にセットする場合は「in」、関数の処理でセットされる場合は「out」になります。
UserCallOut_GetUserCfg
コールアウトカスタムパラメーターをセキュリティプラグインに通知します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_GetUserCfg ( StCustomParamCfg CalloutCfgs[] , LPDWORD CfgNum ) | |||
| 引数 | StCustomParamCfg [] | CalloutCfgs | out | パラメーター情報の配列 |
| LPDWORD | CfgNum | out | パラメーター情報の要素数 | |
| 機能 | コールアウトカスタムパラメーターをセキュリティプラグインに通知します。 | |||
| 呼出 | このAPIは、「Callout Custom Param Setting」ダイアログが表示される時に呼び出されます。 | |||
UserCallOut_SetUserCfg
セキュリティプラグインからコールアウトカスタムパラメーターを受け取ります。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_SetUserCfg ( StCustomParamCfg CalloutCfgs[] , DWORD CfgNum ) | |||
| 引数 | StCustomParamCfg [] | CalloutCfgs | in | パラメーター情報の配列 |
| LPDWORD | CfgNum | in | パラメーター情報の要素数 | |
| 機能 | セキュリティプラグインからコールアウトカスタムパラメーターを受け取ります。 | |||
| 呼出 | このAPIは 、「Callout Custom Param Setting」ダイアログで「OK」ボタンをクリックした時に呼び出されます。 | |||
UserCallOut_ChInit
チャンネル毎に必要な初期化処理を実施します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_ChInit ( DWORD Ch , DWORD InnerCh ) | |||
| 引数 | DWORD | Ch | in | チャンネル |
| DWORD | InnerCh | in | 内部チャンネル | |
| 機能 | チャンネル毎に必要な初期化処理を実施します。 | |||
| 呼出 | このAPIは、モニタ開始時に各チャンネルの送信スレッドと受信スレッドを起動する直前に、チャンネル毎に1回ずつ呼び出されます。 | |||
UserCallOut_ChDeInit
チャンネル毎に必要な終了処理を実施します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_ChDeInit ( DWORD Ch , DWORD InnerCh ) | |||
| 引数 | DWORD | Ch | in | チャンネル |
| DWORD | InnerCh | in | 内部チャンネル | |
| 機能 | チャンネル毎に必要な終了処理を実施します。 | |||
| 呼出 | このAPIは、モニタ停止時に各チャンネルの 送信スレッドと受信スレッドを終了させる直前に、チャンネル毎に1回ずつ呼び出されます。 | |||
UserCallOut_MonStart
モニタ開始を通知します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_MonStart ( DWORD Ch , DWORD InnerCh , DWORD ThreadType , StMsgConfig PrefixCfg , | |||
| 引数 | DWORD | Ch | in | チャンネル |
| DWORD | InnerCh | in | 内部チャンネル | |
| DWORD | ThreadType | in | 呼び出し元スレッド | |
| StMsgConfig | PrefixCfg | in | プリフィックスのセキュリティ設定 | |
| StMsgConfig | PostfixCfg | in | ポストフィックスのセキュリティ設定 | |
| 機能 | モニタ開始を通知します。 | |||
| 呼出 | このAPIは、モニタ開始時にメッセージ認証を有効に設定した各チャンネルの送信スレッドと受信スレッドから、それぞれ呼び出されます。 | |||
| 補足 | ThreadTypeにセットする値については、「スレッド種別」を参照してください。 | |||
UserCallOut_CreMacDaPreFixReq
送信用MAC生成に使用するプリフィックスを要求します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_CreMacDaPreFixReq ( StFrameCfg FrameCfg , StFrameInfo FrameInfo , LPBYTE Prefix , LPDWORD PrefixLen ) | |||
| 引数 | StFrameCfg | FrameCfg | in | 送信フレームコンフィグ設定情報 |
| StFrameInfo | FrameInfo | in | 送信フレーム情報 | |
| LPBYTE | Prefix | out | プリフィックス出力先へのポインタ | |
| LPDWORD | PrefixLen | out | プリフィックスのデータ長(バイト単位)出力先へのポインタ | |
| 機能 | 送信用MAC生成に使用するプリフィックスを要求します。 | |||
| 呼出 | このAPIは、送信メッセージ生成中において、MAC生成前に送信スレッドから呼び出されます。 | |||
UserCallOut_CreMacDaPostFixReq
送信用MAC生成に使用するポストフィックスを要求します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_CreMacDaPostFixReq ( StFrameCfg FrameCfg , StFrameInfo FrameInfo , LPBYTE Postfix , LPDWORD PostfixLen ) | |||
| 引数 | StFrameCfg | FrameCfg | in | 送信フレームコンフィグ設定情報 |
| StFrameInfo | FrameInfo | in | 送信フレーム情報 | |
| LPBYTE | Postfix | out | ポストフィックス出力先へのポインタ | |
| LPDWORD | PostfixLen | out | ポストフィックスのデータ長(バイト単位)出力先へのポインタ | |
| 機能 | 送信用MAC生成に使用するポストフィックスを要求します。 | |||
| 呼出 | このAPIは、送信メッセージ生成中において、MAC生成前に送信スレッドから呼び出されます。 | |||
UserCallOut_TruncatedFvReq
メッセージに乗せる切り出しFVを要求します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_TruncatedFvReq ( StFrameCfg FrameCfg , StFrameInfo FrameInfo , StPrePostData Prefix , | |||
| 引数 | StFrameCfg | FrameCfg | in | 送信フレームコンフィグ設定情報 |
| StFrameInfo | FrameInfo | in | 送信フレーム情報 | |
| StPrePostData | Prefix | in | MAC生成に用いたプリフィックス | |
| StPrePostData | Postfix | in | MAC生成に用いたポストフィックス | |
| LPBYTE | TruncatedFv | out | 切り出しFV出力先へのポインタ | |
| LPDWORD | TruncatedFvLen | out | 切り出しFVのデータ長(バイト単位)出力先へのポインタ | |
| 機能 | メッセージに乗せる切り出しFVを要求します。 | |||
| 呼出 | このAPIは、MicroPeckerXに対する送信要求の直前に、送信スレッドから呼び出されます。 | |||
UserCallOut_MacDaPreFixReq
検証用MAC生成に使用するプリフィックスを要求します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_MacDaPreFixReq ( DWORD VeryAttemptCnt , StFrameCfg FrameCfg , StFrameInfo FrameInfo , | |||
| 引数 | DWORD | VeryAttemptCnt | in | 検証試行回数 |
| StFrameCfg | FrameCfg | in | 送信フレームコンフィグ設定情報 | |
| StFrameInfo | FrameInfo | in | 送信フレーム情報 | |
| LPBYTE | Prefix | out | プリフィックス出力先へのポインタ | |
| LPDWORD | PrefixLen | out | プリフィックスのデータ長(バイト単位)出力先へのポインタ | |
| 機能 | 検証用MAC生成に使用するプリフィックスを要求します。 | |||
| 呼出 | このAPIは、MAC検証の前にモニタスレッドから呼び出されます。 | |||
UserCallOut_MacDaPostFixReq
検証用MAC生成に使用するポストフィックスを要求します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_MacDaPostFixReq ( DWORD VeryAttemptCnt , | |||
| 引数 | DWORD | VeryAttemptCnt | in | 検証試行回数 |
| StFrameCfg | FrameCfg | in | 送信フレームコンフィグ設定情報 | |
| StFrameInfo | FrameInfo | in | 送信フレーム情報 | |
| LPBYTE | Postfix | out | ポストフィックス出力先へのポインタ | |
| LPDWORD | PostfixLen | out | ポストフィックスのデータ長(バイト単位)出力先へのポインタ | |
| 機能 | 検証用MAC生成に使用するポストフィックスを要求します。 | |||
| 呼出 | このAPIは、MAC検証の前にモニタスレッドから呼び出されます。 | |||
UserCallOut_AfterMacVerify
MAC検証結果を通知します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_AfterMacVerify ( StFrameCfg FrameCfg , | |||
| 引数 | StFrameCfg | FrameCfg | in | 送信フレームコンフィグ設定情報 |
| StFrameInfo | FrameInfo | in | 送信フレーム情報 | |
| StPrePostData | Prefix | in | MAC生成に用いたプリフィックス | |
| StPrePostData | Postfix | in | MAC生成に用いたポストフィックス | |
| DWORD | VerifyResult | in | MAC検証結果 | |
| 機能 | MAC検証結果を通知します。 | |||
| 呼出 | このAPIは、MAC検証の後にモニタスレッドから呼び出されます。 | |||
UserCallOut_AfterTransMsg
MAC送信要求の完了を通知します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_AfterTransMsg ( StFrameCfg FrameCfg , | |||
| 引数 | StFrameCfg | FrameCfg | in | 送信フレームコンフィグ設定情報 |
| StFrameInfo | FrameInfo | in | 送信フレーム情報 | |
| 機能 | MAC送信要求の完了を通知します。 | |||
| 呼出 | このAPIは、MicroPeckerXに対する送信要求の直後に呼び出されます。 | |||
UserCallOut_MonStop
モニタ停止を通知します。
| 項目 | 内容 | |||
|---|---|---|---|---|
| 形式 | DWORD UserCallOut_MonStop ( DWORD Ch , DWORD InnerCh , | |||
| 引数 | DWORD | Ch | in | チャンネル |
| DWORD | InnerCh | in | 内部チャンネル | |
| DWORD | ThreadType | in | 呼び出し元スレッド | |
| StMsgConfig | PrefixCfg | in | プリフィックスのセキュリティ設定 | |
| StMsgConfig | PostfixCfg | in | ポストフィックスのセキュリティ設定 | |
| 機能 | モニタ停止を通知します。 | |||
| 呼出 | このAPIは、モニタ停止時にメッセージ認証を有効に設定した各チャンネルの送信スレッドと受信スレッドから、それぞれ呼び出されます。 | |||
| 補足 | ThreadTypeにセットする値については、「スレッド種別」を参照してください。 | |||