構造体定義
コールアウトDLLの仕様について説明します。
構造体定義
以下の構造体が定義されています。
| 構造体型名 | 意味合い |
|---|---|
| StElementCfg | 要素設定情報 |
| StFrameCfg | 送受信フレームコンフィグ設定情報 |
| StPrePostData | プリフィックス/ポストフィックス情報 |
| StMsgConfig | チャンネルメッセージコンフィグ設定情報 |
| StFrameInfo | 送受信フレーム情報 |
| StCustomParamCfg | コールアウトカスタムパラメーター情報 |
StElementCfg
StElementCfg構造体（要素設定情報）のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い |
|---|---|---|
| StartPos | DWORD | 要素のビット位置の始点 |
| EndPos | DWORD | 要素のビット位置の終点 |
| Value | LPBYTE | 要素の初期値 |
| ValueLength | DWORD | 要素の長さ（ビット単位）(※1) |
| Align | DWORD | ビットアラインメント(※2) |
| Endianness | DWORD | バイトエンディアン(※2) |
※1: 要素の長さは、startPosとendPosによって自動的に決まります。
※2: 値の意味合いについては、定数定義を参照してください。
StFrameCfg
StFrameCfg構造体（送受信フレームコンフィグ設定情報）のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い |
|---|---|---|
| SecMsgIdx | DWORD | メッセージインデックス |
| PrePostLen | DWORD | プリフィックス/ポストフィックスのデータ長（ビット単位） |
| ElCfgs | StElementCfg * | プリフィックス/ポストフィックスの要素設定情報構造体配列 |
| ElementNum | DWORD | 要素設定情報構造体配列の要素数 |
| IsSyncMsg | BOOL | 同期メッセージ有効/無効 Trueは有効、Falseは無効をそれぞれ意味します。 |
| IsUseFv | BOOL | FV使用有無(※1) |
| IsFvMaster | BOOL | FVマスター/スレーブ Trueはマスター、Falseはスレーブをそれぞれ意味します。 |
| Reserve | BOOL | 予約領域 |
StPrePostData
StPrePostData構造体（プリフィックス/ポストフィックス情報）のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い |
|---|---|---|
| Value | LPBYTE | プリフィックス/ポストフィックスの値 |
| Length | DWORD | プリフィックス/ポストフィックスの長さ（ビット単位） |
StMsgConfig
t_MsgConfig構造体（チャンネルメッセージコンフィグ設定情報）のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い |
|---|---|---|
| MsgCfg | StFrameCfg * | チャンネルが保有するメッセージ情報構造体配列 |
| MsgNum | DWORD | チャンネルが保有するメッ セージ情報構造体配列の要素数 |
StFrameInfo
StFrameInfo構造体（送受信フレーム情報）のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い |
|---|---|---|
| AllPayLoad | LPBYTE | CAN/CANFDメッセージデータの値 |
| AllLength | DWORD | CAN/CANFDメッセージデータ長（ビット単位） |
| TruncPayLoad | LPBYTE | ペイロード切り出しデータの値 |
| TruncPayLoadLength | DWORD | ペイロード切り出しデータ長（ビット単位） |
| TruncFV | LPBYTE | FV切り出しデータの値 |
| TruncFVLength | DWORD | FV切り出しデータ長（ビット単位） |
| TruncMac | LPBYTE | MAC切り出しデータの値 |
| TruncMacLength | DWORD | MAC切り出しデータ長（ビット単位） |
| ID | - | CAN ID情報 |
| State | - | 送受信フレームモニタ情報 |
ID 構造体
IDは、StdID（標準ID情報）、ExtID（拡張ID情報）、Type（エラー情報）の共用体で、いずれもDWORD型のビットフィールドによる構造体となっています。
それぞれのメンバは以下の通りです。
| 構造体名 | 変数名 | ビット数 | 意味合い |
|---|---|---|---|
| StdID | - | 18 | 未使用 |
| CANID | 11 | 標準CAN ID | |
| - | 3 | 未使用 | |
| ExtID | CANID | 29 | 拡張CAN ID |
| - | 3 | 未使用 | |
| Type | - | 30 | 未使用 |
| RTR | 1 | リモート送信要求（RTR）(※) | |
| IDE | 1 | CAN-IDの種類（IDE）(※) |
※: 値の意味合いについては、定数定義を参照してください。
State 構造体
Stateは、DWORD型のビットフィールドによる構造体となっています。メンバは以下の通りです。
| 変数名 | ビット数 | 意味合い |
|---|---|---|
| LogType | 6 | 送受信フレームのプロトコル (※1) |
| Dir | 1 | 送受信方向(※1) |
| Error | 1 | エラー有無(※2) |
※1: 値の意味合いについては、定数定義を参照してください。
※2: エラーコードの定数定義のうち、MPX_COUT_OKがエラーなし、MPX_COUT_ERRORがエラーあり、をそれぞれ意味します。
StCustomParamCfg
StCustomParamCfg構造体（コールアウトカスタムパラメーター情報）のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い |
|---|---|---|
| UserType | DWORD | コールアウトカスタムパラメーターのデータ型(※1) |
| Data | LPVOID | コールアウトカスタムパラメーターの値 |
| ByteLength | DWORD | コールアウトカスタムパラメーターのデータ長（バイト単位、最大256バイト）(※2) |
| ItemName | DWORD | コールアウトカスタムパラメーター名 |
※1: 値の意味合いについては、定数定義を参照してください。
※2: データ型が文字列の場合のみ有効です。