TIM SDK
TIM API C
display_product_info.h File Reference

Description

Display product info.

Object type display_product_info.

Functions

ta_e_result_code_t ta_display_product_info_create (ta_object_t *info)
 Create display product info. More...
 
ta_e_result_code_t ta_display_product_info_copy (ta_object_t *info, const ta_object_t *source_info)
 Create copy of display product info. More...
 
ta_e_result_code_t ta_display_product_info_get_image_file_format (ta_object_t info, ta_e_image_file_format_t *image_file_format)
 Image file format. More...
 
ta_e_result_code_t ta_display_product_info_set_image_file_format (ta_object_t info, ta_e_image_file_format_t image_file_format)
 Set image file format. More...
 
ta_e_result_code_t ta_display_product_info_get_image_file_width (ta_object_t info, int *image_file_width)
 Image file width in pixels. More...
 
ta_e_result_code_t ta_display_product_info_set_image_file_width (ta_object_t info, int image_file_width)
 Set image file width in pixels. More...
 
ta_e_result_code_t ta_display_product_info_get_image_file_height (ta_object_t info, int *image_file_height)
 Image file height in pixels. More...
 
ta_e_result_code_t ta_display_product_info_set_image_file_height (ta_object_t info, int image_file_height)
 Set image file height in pixels. More...
 
ta_e_result_code_t ta_display_product_info_get_image_data (ta_object_t info, ta_object_t *data)
 Image data in specified format. More...
 
ta_e_result_code_t ta_display_product_info_set_image_data (ta_object_t info, ta_object_t data)
 Set image data in specified format. More...
 
ta_e_result_code_t ta_display_product_info_get_background_color (ta_object_t info, ta_s_color_t *background_color)
 Background color. More...
 
ta_e_result_code_t ta_display_product_info_set_background_color (ta_object_t info, const ta_s_color_t *background_color)
 Set background color. More...
 
ta_e_result_code_t ta_display_product_info_get_product_display_name (ta_object_t info, ta_object_t *name)
 Product display name. More...
 
ta_e_result_code_t ta_display_product_info_set_product_display_name (ta_object_t info, ta_object_t name)
 Set product display name. More...
 

Function Documentation

◆ ta_display_product_info_copy()

ta_e_result_code_t ta_display_product_info_copy ( ta_object_t info,
const ta_object_t source_info 
)

Create copy of display product info.

Parameters
[out]infoPointer to variable to write created object instance to. Created object instance is retained.
[in]source_infoObject of type display_product_info to create copy of.
Return values
ta_c_rc_okObject instance has been created and written to info.
ta_c_rc_invalid_argumentinfo is null-pointer.
ta_c_rc_invalid_argumentsource_info is ta_invalid_object.
ta_c_rc_invalid_argumentsource_info is not of type display_product_info.
ta_c_rc_out_of_memoryFailed allocating memory.

◆ ta_display_product_info_create()

ta_e_result_code_t ta_display_product_info_create ( ta_object_t info)

Create display product info.

Parameters
[out]infoPointer to variable to write created object instance to. Created object instance is retained.
Return values
ta_c_rc_okObject instance has been created and written to info.
ta_c_rc_invalid_argumentinfo is null-pointer.
ta_c_rc_out_of_memoryFailed allocating memory.

◆ ta_display_product_info_get_background_color()

ta_e_result_code_t ta_display_product_info_get_background_color ( ta_object_t  info,
ta_s_color_t background_color 
)

Background color.

Parameters
[in]infoObject instance of type display_product_info.
[out]background_colorPointer to variable to write value to.
Return values
ta_c_rc_okValue written to background_color.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentbackground_color is null-pointer.

◆ ta_display_product_info_get_image_data()

ta_e_result_code_t ta_display_product_info_get_image_data ( ta_object_t  info,
ta_object_t data 
)

Image data in specified format.

Parameters
[in]infoObject instance of type display_product_info.
[out]dataPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in info.
Return values
ta_c_rc_okObject instance written to data.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentdata is null-pointer.

◆ ta_display_product_info_get_image_file_format()

ta_e_result_code_t ta_display_product_info_get_image_file_format ( ta_object_t  info,
ta_e_image_file_format_t image_file_format 
)

Image file format.

Parameters
[in]infoObject instance of type display_product_info.
[out]image_file_formatPointer to variable to write value to. Value is ta_c_iff_undefined if value is not set in info.
Return values
ta_c_rc_okValue written to image_file_format.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentimage_file_format is null-pointer.

◆ ta_display_product_info_get_image_file_height()

ta_e_result_code_t ta_display_product_info_get_image_file_height ( ta_object_t  info,
int *  image_file_height 
)

Image file height in pixels.

Parameters
[in]infoObject instance of type display_product_info.
[out]image_file_heightPointer to variable to write value to.
Return values
ta_c_rc_okValue written to image_file_height.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentimage_file_height is null-pointer.

◆ ta_display_product_info_get_image_file_width()

ta_e_result_code_t ta_display_product_info_get_image_file_width ( ta_object_t  info,
int *  image_file_width 
)

Image file width in pixels.

Parameters
[in]infoObject instance of type display_product_info.
[out]image_file_widthPointer to variable to write value to.
Return values
ta_c_rc_okValue written to image_file_width.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentimage_file_width is null-pointer.

◆ ta_display_product_info_get_product_display_name()

ta_e_result_code_t ta_display_product_info_get_product_display_name ( ta_object_t  info,
ta_object_t name 
)

Product display name.

Parameters
[in]infoObject instance of type display_product_info.
[out]namePointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in info.
Return values
ta_c_rc_okObject instance written to name.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentname is null-pointer.

◆ ta_display_product_info_set_background_color()

ta_e_result_code_t ta_display_product_info_set_background_color ( ta_object_t  info,
const ta_s_color_t background_color 
)

Set background color.

Parameters
[in]infoObject instance of type display_product_info.
[in]background_colorPointer to value to set.
Return values
ta_c_rc_okValue assigned to info.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentbackground_color is null-pointer.

◆ ta_display_product_info_set_image_data()

ta_e_result_code_t ta_display_product_info_set_image_data ( ta_object_t  info,
ta_object_t  data 
)

Set image data in specified format.

Parameters
[in]infoObject instance of type display_product_info.
[in]dataObject instance to set. Object instance can be ta_invalid_object to clear the value in info. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to info.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentdata is not ta_invalid_object and is not of type string.

◆ ta_display_product_info_set_image_file_format()

ta_e_result_code_t ta_display_product_info_set_image_file_format ( ta_object_t  info,
ta_e_image_file_format_t  image_file_format 
)

Set image file format.

Parameters
[in]infoObject instance of type display_product_info.
[in]image_file_formatValue to set.
Return values
ta_c_rc_okValue assigned to info.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentimage_file_format is ta_c_iff_undefined.

◆ ta_display_product_info_set_image_file_height()

ta_e_result_code_t ta_display_product_info_set_image_file_height ( ta_object_t  info,
int  image_file_height 
)

Set image file height in pixels.

Parameters
[in]infoObject instance of type display_product_info.
[in]image_file_heightValue to set.
Return values
ta_c_rc_okValue assigned to info.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentimage_file_height is less than 1.

◆ ta_display_product_info_set_image_file_width()

ta_e_result_code_t ta_display_product_info_set_image_file_width ( ta_object_t  info,
int  image_file_width 
)

Set image file width in pixels.

Parameters
[in]infoObject instance of type display_product_info.
[in]image_file_widthValue to set.
Return values
ta_c_rc_okValue assigned to info.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentimage_file_width is less than 1.

◆ ta_display_product_info_set_product_display_name()

ta_e_result_code_t ta_display_product_info_set_product_display_name ( ta_object_t  info,
ta_object_t  name 
)

Set product display name.

Parameters
[in]infoObject instance of type display_product_info.
[in]nameObject instance to set. Object instance can be ta_invalid_object to clear the value in info. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to info.
ta_c_rc_invalid_argumentinfo is ta_invalid_object.
ta_c_rc_invalid_argumentinfo is not of type display_product_info.
ta_c_rc_invalid_argumentname is not ta_invalid_object and is not of type string.