Callbacks

ParameterConvertFunc (out, in_)

Details

Infinoted.ParameterConvertFunc(out, in_)

Parameters:

• out (object or None) – Location where the converted value should be written to.

• in (object or None) – Location where the original input value should be taken from.

Returns:

True on success or False if an error occurred.

Return type:

bool

Definition of a parameter conversion function. A parameter conversion function transforms the value of a read which is one of the InfinotedParameterValue enumeration to its final internal representation. It can change the C type of the parameter, and it can also validate the input and produce an error if the input value is invalid.

While plugin developers can write their own conversion functions, many are already provided by libinfinoted-plugin-manager that cover the most basic usecases. These functions are Infinoted.parameter_convert_string(), Infinoted.parameter_convert_string_list(), Infinoted.parameter_convert_filename(), Infinoted.parameter_convert_boolean(), Infinoted.parameter_convert_port(), Infinoted.parameter_convert_nonnegative(), Infinoted.parameter_convert_positive(), Infinoted.parameter_convert_security_policy() and Infinoted.parameter_convert_ip_address().