integer.h File Reference

Description

Integer value.

Object type integer.

Functions
ta_e_result_code_t	ta_integer_create (ta_object_t *integer, int64_t value)
	Create immutable 64-bit integer instance. More...
ta_e_result_code_t	ta_integer_get_value (ta_object_t integer, int64_t *value)
	Get value of integer. More...

Function Documentation

ta_integer_create()

ta_e_result_code_t ta_integer_create	(	ta_object_t *	integer,
		int64_t	value
	)

Create immutable 64-bit integer instance.

Caller retains a reference to the created integer. Different users can individually retain the integer instance themselves by calling ta_object_retain. Each call to ta_object_retain and ta_integer_create has to be matched with a call to ta_object_release. The integer instance is destroyed once nobody retains the integer instance anymore.

Parameters

[out]	integer	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	value	Value of integer.

Return values

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

ta_integer_get_value()

ta_e_result_code_t ta_integer_get_value	(	ta_object_t	integer,
		int64_t *	value
	)

Get value of integer.

Parameters

[in]	integer	Object instance of type integer.
[out]	value	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to value.
ta_c_rc_invalid_argument	integer is ta_object_invalid.
ta_c_rc_invalid_argument	integer is not of type integer.
ta_c_rc_invalid_argument	value is null-pointer.