reconfig_parameters.h File Reference

Description

Reconfig Parameters.

Object type reconfig_parameters.

Functions
ta_e_result_code_t	ta_reconfig_parameters_create (ta_object_t *reconfig_parameters)
	Create object of type reconfig_parameters. More...
ta_e_result_code_t	ta_reconfig_parameters_set_reconfig_mode (ta_object_t reconfig_parameters, ta_e_reconfig_mode_t reconfig_mode)
	Set optional reconfig mode. More...
ta_e_result_code_t	ta_reconfig_parameters_set_acq_id (ta_object_t reconfig_parameters, ta_object_t acq_id)
	Set optional acq id. More...

Function Documentation

ta_reconfig_parameters_create()

ta_e_result_code_t ta_reconfig_parameters_create

(

ta_object_t *

reconfig_parameters

)

Create object of type reconfig_parameters.

Parameters

[out]

reconfig_parameters

Pointer to variable to write created object instance to. Created object instance is retained.

Return values

ta_c_rc_ok	Object instance has been created and written to reconfig_parameters.
ta_c_rc_invalid_argument	reconfig_parameters is null-pointer.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_reconfig_parameters_set_acq_id()

ta_e_result_code_t ta_reconfig_parameters_set_acq_id	(	ta_object_t	reconfig_parameters,
		ta_object_t	acq_id
	)

Set optional acq id.

Parameters

[in]	Object	instance of type reconfig_parameters.
[in]	acq_id	Object instance to set. Object instance can be ta_object_invalid to clear the value in reconfig_parameters. If object instance is not ta_object_invalid is has to be of type integer.

Return values

ta_c_rc_ok	Object instance assigned to reconfig_parameters.
ta_c_rc_invalid_argument	reconfig_parameters is ta_object_invalid.
ta_c_rc_invalid_argument	reconfig_parameters is not of type reconfig_parameters.
ta_c_rc_invalid_argument	acq_id is not ta_object_invalid and is not of type integer.

ta_reconfig_parameters_set_reconfig_mode()

ta_e_result_code_t ta_reconfig_parameters_set_reconfig_mode	(	ta_object_t	reconfig_parameters,
		ta_e_reconfig_mode_t	reconfig_mode
	)

Set optional reconfig mode.

Parameters

[in]	Object	instance of typereconfig_parameters.
[in]	reconfig_mode	Value to set.Value can be ta_c_reconfig_mode_undefined to clear the value in reconfig_parameters.

Return values

ta_c_rc_ok	Value assigned to reconfig_parameters.
ta_c_rc_invalid_argument	reconfig_parameters is ta_object_invalid.
ta_c_rc_invalid_argument	reconfig_parameters is not of typereconfig_parameters.
ta_c_rc_invalid_argument	reconfig_mode is null - pointer.