RP 1210 Required Functions
This section describes the required functions of the RP1210 API. Note that an implementation claiming to conform to this API shall minimally support these functions without deviating in name (case-sensitivity preserved), return type, functionality as defined herein, or argument list.
Even though an API may not support a particular function, it still needs to have the function in the DLL. For example, RP12W_loctl () shall be in the DLL even though it is used mainly for automotive protocols such as ISO9141, and ISO14230. The application should always check return values on functions needed after loading the DLL and assigning function pointers as some older APIs may not have these functions.
The required functionality is constituted by the following set of functions:
| Function Name | Brief Description |
|---|---|
| RP1210_C1ientConnect | Establishes a logical client connection with the API DLL |
| RP1210_ClientDisconnect | Disconnects the logical client connection from the API DLL. |
| RP1210_SendCommand | Sends a command to the API DLL for things like filtering, etc. |
| RP1210_SendMessage | Sends a message to the API DLL for transmit. |
| RP1210_ReadMessage | Reads a message from the API DLL from the databus. |
| RP1210_ReadVersion | Reads version information from the API, about the API. |
| RP1210_ReadDetailedVersion | Newer more comprehensive version information command. This command is now preferred over the RP1210_ReadVersion () call. |
| RP1210_GetErrorMsg | Translates an RP 1210 error code into a textual description of the error. |
| RP1210_GetLastErrorMsg | Translates an RP 1210 error code into a more detailed error code and textual description. |
| RP1210_GetHardwareStatus | Returns information state of the connection and datalink. |
| RP1210_GetHardwareStatusEx | Returns information state of the connection and data link. This function was added in 2013 and supersedes RP1210_GetHardwareStatus ( ). |
| RP1210_Ioctl | Used to modify the state of vehicle communications. This was new to RP 1210B, and is only used by RP 1210 at this time by ISO9141, ISO14230, and ISO15765 communications. This function allows for future development in RP 1210 with regards to more automotive type protocols. |