Description

Boolean value.

Object type boolean.

Typedefs
typedef enum ta_e_boolean	ta_e_boolean_t
	Boolean value.

Enumerations
enum	ta_e_boolean { ta_c_b_undefined, ta_c_b_true, ta_c_b_false }
	Boolean value. More...

Functions
ta_e_result_code_t	ta_boolean_create (ta_object_t *boolean, ta_e_boolean_t value)
	Create immutable boolean instance. More...

ta_e_result_code_t	ta_boolean_get_value (ta_object_t boolean, ta_e_boolean_t *value)
	Get value of boolean. More...

Enumeration Type Documentation

◆ ta_e_boolean

enum ta_e_boolean

Boolean value.

Enumerator
ta_c_b_undefined	Invalid/undefined.
ta_c_b_true	True value.
ta_c_b_false	False value.

Function Documentation

◆ ta_boolean_create()

ta_e_result_code_t ta_boolean_create	(	ta_object_t *	boolean,
		ta_e_boolean_t	value
	)

Create immutable boolean instance.

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

Parameters

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

Return values

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

◆ ta_boolean_get_value()

ta_e_result_code_t ta_boolean_get_value	(	ta_object_t	boolean,
		ta_e_boolean_t *	value
	)

Get value of boolean.