item_quantity.h File Reference

Description

Item quantity.

Object type item_quantity.

Functions
ta_e_result_code_t	ta_item_quantity_get_quantity (ta_object_t item_quantity, int *quantity)
	Quantity of the product. More...
ta_e_result_code_t	ta_item_quantity_get_exponent (ta_object_t item_quantity, int *exponent)
	Exponent of quantity of the product. More...
ta_e_result_code_t	ta_item_quantity_get_quantity_type (ta_object_t item_quantity, ta_object_t *type)
	Type of quantity of the product. More...

Function Documentation

ta_item_quantity_get_exponent()

ta_e_result_code_t ta_item_quantity_get_exponent	(	ta_object_t	item_quantity,
		int *	exponent
	)

Exponent of quantity of the product.

Parameters

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

Return values

ta_c_rc_ok	Object instance written to exponent.
ta_c_rc_invalid_argument	item_quantity is ta_invalid_object.
ta_c_rc_invalid_argument	item_quantity is not of type item_quantity.
ta_c_rc_invalid_argument	exponent is null-pointer.

ta_item_quantity_get_quantity()

ta_e_result_code_t ta_item_quantity_get_quantity	(	ta_object_t	item_quantity,
		int *	quantity
	)

Quantity of the product.

Parameters

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

Return values

ta_c_rc_ok	Object instance written to quantity.
ta_c_rc_invalid_argument	item_quantity is ta_invalid_object.
ta_c_rc_invalid_argument	item_quantity is not of type item_quantity.
ta_c_rc_invalid_argument	quantity is null-pointer.

ta_item_quantity_get_quantity_type()

ta_e_result_code_t ta_item_quantity_get_quantity_type	(	ta_object_t	item_quantity,
		ta_object_t *	type
	)

Type of quantity of the product.

Parameters

[in]	item_quantity	Object instance of type item_quantity.
[out]	type	Pointer to variable to write object instance to. Object instance is of type string and is not retained.

Return values

ta_c_rc_ok	Object instance written to type.
ta_c_rc_invalid_argument	item_quantity is ta_invalid_object.
ta_c_rc_invalid_argument	item_quantity is not of type item_quantity.
ta_c_rc_invalid_argument	type is null-pointer.