My Project
|
Adds a value by key. More...
Variables | |
static final int | MSG_RI_ADD_VALUE_BY_KEY = 110 |
Adds a value by key.
Adds a key value pair to the navigation application. The pair is stored internally for a given amount of time and a specified priority. The key value pair can be retrieved by the Retrieve a value for a certain key call.
The type of the value is represented by a digit.
Use 1 for integers, 2 for floats and 3 for strings.
You can even use your own types if you know what you're doing. The values are stored as strings internally.
The duration measured in milliseconds will define for how long the key value pair should be valid. The key value pair will be internally deleted after the duration expired and cannot be retrieved anymore.
If you don't want the data to expire just use 0 as duration.
You can add data with the same key but different priorities and later retrieve the data by a given priority or the highest priority. The valid range for priorities is from 1 (lowest) to 100 (highest). Please use the following priorities as a default:
1: default value
5: simulated value
6: user input
7: current value
10: simulation
The combination of key and priority is stored unique, so if you add data with the same key and priority again, the previous data will be overwritten.
Key | Value | Type | Info |
---|---|---|---|
Key | A string which represents the key value pair | String | |
Value | The value to store | String | |
Type | The type of the value | int | |
Duration | The duration in milliseconds | int | |
Priority | The priority to set | int |
RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.
© PTV Group 2021 | Generated on Sun Oct 2 2022 19:28:23 for My Project by 1.8.17 |