Description (D2000 KomAPI)
D2000 KomAPI - interface description
Protocol dynamic link library (.DLL) exports a set of functions, which are called by the D2000 KOM process. The list of all the exported functions is shown in the following table with a brief description.
On the Linux platform, the dynamic library extension is different (.so), and the function names are without underscore and size specifications (e. g. Init instead of _Init@4).
Function name | Requirement | Meaning |
|---|---|---|
_Init@4 | Required | The function is called after DLL dynamic import. |
_ReadAllPoints@4 | Optional (recommended) | Reading of values of all station I/O tags. |
_ReadStoredData@28 | Optional | Reading of historical values of station I/O tags. |
_ReadPointValue@8 | Optional | Reading of I/O tag value. |
_WritePointValue@16 | Optional | Writing of a new I/O tag value. |
_InitStation@4 | Optional | Definition of new station parameters. |
_DeleteStation@4 | Optional | Station deleted. |
_TimeSynchroStation@4 | Optional | Station real-time synchronisation. |
_InitPoint@12 | Optional | Definition of new I/O tag parameters. |
_DeletePoint@4 | Optional | I/O tag deleted. |
_ConfigDone@4 | Optional | Calling the definitions of the station and its I/O tags are done. |
_PointsApplyBack@8 | Optional | Response to calling the call-back procedure PointsApply. |
_StationsApplyBack@8 | Optional | Response to calling the call back procedure PointsApply. |
_ExitProc@0 | Optional | Called when stopping D2000 KOM. |
_ExitProcWithLnPar@4 | Optional | Called when stopping D2000 KOM. |
_RdStatusChanged@4 | Optional | Called when switching the redundancy or changing the instance of D2000 KOM between active and passive. |
Note
All the used KomAPI functions and procedures (including call-back functions and internal tasks) require the Stdcall call convention on the Windows platform.
Related pages: