Simple Virtual Machine
A simple but flexible virtual machine
SVM variable parameters

This module contains API functions to handle SVM variable parameters. More...

Functions

SVM_FUNCTION SVM_Boolean svm_parameter_type_is_variable (const void *svm, const SVM_Parameter parameter)
 This function checks whether a parameter contains a variable. More...
 
SVM_FUNCTION SVM_Variable svm_parameter_variable_get (const void *svm, const SVM_Parameter parameter)
 This function converts a parameter into a variable. More...
 
SVM_FUNCTION SVM_Parameter svm_parameter_variable_new (const void *svm, const SVM_Variable variable)
 This function creates a parameter from a variable. More...
 

Detailed Description

This module contains API functions to handle SVM variable parameters.

Function Documentation

◆ svm_parameter_type_is_variable()

SVM_FUNCTION SVM_Boolean svm_parameter_type_is_variable ( const void *  svm,
const SVM_Parameter  parameter 
)

This function checks whether a parameter contains a variable.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]parameterThe callback parameter to check.
Returns
TRUE if the parameter contains a variable, FALSE otherwise.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)

◆ svm_parameter_variable_get()

SVM_FUNCTION SVM_Variable svm_parameter_variable_get ( const void *  svm,
const SVM_Parameter  parameter 
)

This function converts a parameter into a variable.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]parameterThe callback parameter to check.
Returns
The variable as a SVM_Variable.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)
FAILUREinterruption when the parameter does not contain a variable.
See also
svm_parameter_type_is_variable

◆ svm_parameter_variable_new()

SVM_FUNCTION SVM_Parameter svm_parameter_variable_new ( const void *  svm,
const SVM_Variable  variable 
)

This function creates a parameter from a variable.

Parameters
[in]svmThe SVM pointer passed as first argument of the callback function.
[in]variableThe variable to be passed as a parameter.
Returns
A parameter containing the variable.
Exceptions
FAILUREinterruption when a parameter is incorrect. (Please refer to the main description page of this API.)