Skip to main content

Structure Definitions

This section explains the Callout DLL specification.

Structures

The following structures are defined.

Structure TypeDescription
StElementCfgElement configuration information
StFrameCfgTX/RX frame configuration information
StPrePostDataPrefix/Postfix information
StMsgConfigChannel message configuration information
StFrameInfoTX/RX frame information
StCustomParamCfgCallout custom parameter information

StElementCfg

Members of StElementCfg (element configuration information):

VariableTypeDescription
StartPosDWORDStart bit position of element
EndPosDWORDEnd bit position of element
ValueLPBYTEInitial value of element
ValueLengthDWORDElement length (bit unit) (*1)
AlignDWORDBit alignment (*2)
EndiannessDWORDByte endian (*2)

1: Element length is automatically determined by StartPos and EndPos.
2: For value meanings, refer to constant definitions.

StFrameCfg

Members of StFrameCfg (TX/RX frame configuration information):

VariableTypeDescription
SecMsgIdxDWORDMessage index
PrePostLenDWORDPrefix/Postfix data length (bit unit)
ElCfgsStElementCfg *Array of prefix/postfix element configuration structures
ElementNumDWORDNumber of elements in element configuration array
IsSyncMsgBOOLSync message enable/disable (True = enabled, False = disabled)
IsUseFvBOOLFV usage (*1)
IsFvMasterBOOLFV master/slave (True = master, False = slave)
ReserveBOOLReserved

StPrePostData

Members of StPrePostData (prefix/postfix information):

VariableTypeDescription
ValueLPBYTEPrefix/Postfix value
LengthDWORDPrefix/Postfix length (bit unit)

StMsgConfig

Members of StMsgConfig (channel message configuration information):

VariableTypeDescription
MsgCfgStFrameCfg *Array of message information structures held by channel
MsgNumDWORDNumber of elements in message information array held by channel

StFrameInfo

Members of StFrameInfo (TX/RX frame information):

VariableTypeDescription
AllPayLoadLPBYTECAN/CAN FD message data value
AllLengthDWORDCAN/CAN FD message data length (bit unit)
TruncPayLoadLPBYTETruncated payload data value
TruncPayLoadLengthDWORDTruncated payload data length (bit unit)
TruncFVLPBYTETruncated FV data value
TruncFVLengthDWORDTruncated FV data length (bit unit)
TruncMacLPBYTETruncated MAC data value
TruncMacLengthDWORDTruncated MAC data length (bit unit)
ID-CAN ID information
State-TX/RX frame monitor information

ID structure

ID is a union of StdID (standard ID info), ExtID (extended ID info), and Type (error info), each represented as a DWORD bit-field structure. Members are as follows.

StructureVariableBitsDescription
StdID-18Unused
CANID11Standard CAN ID
-3Unused
ExtIDCANID29Extended CAN ID
-3Unused
Type-30Unused
RTR1Remote Transmission Request (RTR) (*)
IDE1CAN ID type (IDE) (*)

*: For value meanings, refer to constant definitions.

State structure

State is a DWORD bit-field structure with members below.

VariableBitsDescription
LogType6TX/RX frame protocol (*1)
Dir1TX/RX direction (*1)
Error1Error status (*2)

1: For value meanings, refer to constant definitions.
2: In error code constants, MPX_COUT_OK means no error and MPX_COUT_ERROR means error.

StCustomParamCfg

Members of StCustomParamCfg (callout custom parameter information):

VariableTypeDescription
UserTypeDWORDData type of callout custom parameter (*1)
DataLPVOIDValue of callout custom parameter
ByteLengthDWORDData length of callout custom parameter (byte unit, max 256 bytes) (*2)
ItemNameDWORDName of callout custom parameter

1: For value meanings, refer to constant definitions.
2: Valid only when data type is string.