This module contains API functions to handle SVM integer values.
More...
This module contains API functions to handle SVM integer values.
◆ svm_value_integer_get()
This function extracts the raw integer contained in an integer value.
- Parameters
-
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | integer | The integer value to extract from. |
- Returns
- The contained integer.
- Exceptions
-
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the integer parameter does not contain an integer. |
- See also
- svm_value_type_is_integer
-
svm_value_type_get
◆ svm_value_integer_new()
This function creates an integer value the SVM can store in its memories from a raw integer.
- Parameters
-
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | integer | The integer to initiate the integer value. |
- Returns
- The integer value.
- Exceptions
-
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
◆ svm_value_integer_new_null()
This function creates an integer value the SVM can store in its memories without a value.
- Parameters
-
[in] | svm | The SVM pointer passed as first argument of the callback function. |
- Returns
- A non initialised integer value.
- Exceptions
-
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
◆ svm_value_integer_set()
This function replaces the raw integer contained in an integer value from a raw integer.
- Parameters
-
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in,out] | value | The integer value to update. |
[in] | integer | The new integer value. |
- Exceptions
-
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |
FAILURE | interruption when the value parameter does not contain an integer. |
FAILURE | interruption when the value is a constant. |
- See also
- svm_value_type_is_integer
-
svm_value_type_get
◆ svm_value_type_is_integer()
This function checks whether a value contains an integer.
- Parameters
-
[in] | svm | The SVM pointer passed as first argument of the callback function. |
[in] | value | The value to be diagnosed. |
- Returns
- TRUE if the value contains an integer, FALSE otherwise.
- Exceptions
-
FAILURE | interruption when a parameter is incorrect. (Please refer to the main description page of this API.) |