Option APIs for da_handle - 5.2 English - 68552

Set an option, to be stored inside the handle argument.

Parameters:

• handle – [inout] the da_handle which will store the value of the option.

• option – [in] the name of the option to set.

• value – [in] the value to set the option to.

Returns:

da_status. The function returns:

• da_status_success - the option was successfully set.

• da_status_option_not_found - the option was not found. Check the value of option.

• da_status_option_locked - the option cannot be changed at this point.

• da_status_option_wrong_type - the wrong option type was passed.

• da_status_option_invalid_bounds - the option value is out of bounds.

• da_status_option_invalid_value - cannot set option to an invalid value.

• da_status_invalid_pointer - the handle has not been initialized.

• da_status_wrong_type - the handle was initialized with a different floating-point precision from value.

Get the current value of an option stored inside the handle argument.

Parameters:

• handle – [in] the da_handle which stores the options.

• option – [in] the name of the option to get.

• value – [out] the value of the option obtained from the handle.

Returns:

da_status. The function returns:

• da_status_success - the option was successfully returned in value.

• da_status_option_not_found - the option was not found. Check the value of option.

• da_status_option_wrong_type - the wrong option type was passed.

• da_status_invalid_pointer - the handle has not been initialized.

• da_status_wrong_type - the handle was initialized with a different floating-point precision from value.