TIM SDK
TIM API C
show_signature_capture_request.h File Reference

Description

Show signature capture request.

Object type show_signature_capture_request.

Functions

ta_e_result_code_t ta_show_signature_capture_request_create (ta_object_t *request)
 Create show signature capture request. More...
 
ta_e_result_code_t ta_show_signature_capture_request_copy (ta_object_t *request, const ta_object_t *source_request)
 Create copy of show signature capture request. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_brand_bar (ta_object_t request, ta_object_t *brand_bar)
 Brand bar. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_brand_bar (ta_object_t request, ta_object_t brand_bar)
 Set brand bar. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_brand_mode (ta_object_t request, ta_e_brand_mode_t *brand_mode)
 Brand mode. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_brand_mode (ta_object_t request, ta_e_brand_mode_t brand_mode)
 Set brand mode. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_background_color (ta_object_t request, ta_s_color_t *background_color)
 Background color. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_background_color (ta_object_t request, const ta_s_color_t *background_color)
 Set background color. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_image_file_format (ta_object_t request, ta_e_image_file_format_t *image_file_format)
 Image file format to use. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_image_file_format (ta_object_t request, ta_e_image_file_format_t image_file_format)
 Set image file format to use. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_image_file_width (ta_object_t request, int *image_file_width)
 Image file width in pixels. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_image_file_width (ta_object_t request, int image_file_width)
 Set image file width in pixels. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_image_file_height (ta_object_t request, int *image_file_height)
 Image file height in pixels. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_image_file_height (ta_object_t request, int image_file_height)
 Set image file height in pixels. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_resource_id (ta_object_t request, ta_e_resource_id_t *resource_id)
 Resource identifier. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_resource_id (ta_object_t request, ta_e_resource_id_t resource_id)
 Set resource identifier. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_signature_color (ta_object_t request, ta_s_color_t *signature_color)
 Signature color. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_signature_color (ta_object_t request, const ta_s_color_t *signature_color)
 Set signature color. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_theme (ta_object_t request, ta_e_theme_t *theme)
 Theme. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_theme (ta_object_t request, ta_e_theme_t theme)
 Set theme. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_timeout (ta_object_t request, int *timeout)
 Timeout in seconds. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_timeout (ta_object_t request, int timeout)
 Set timeout in seconds. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_language (ta_object_t request, ta_object_t *language)
 Language. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_language (ta_object_t request, ta_object_t language)
 Set language. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_watermark_color (ta_object_t request, ta_s_color_t *watermark_color)
 Watermark color. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_watermark_color (ta_object_t request, const ta_s_color_t *watermark_color)
 Set watermark color. More...
 
ta_e_result_code_t ta_show_signature_capture_request_get_watermark_items (ta_object_t request, ta_object_t *watermark_items)
 List of watermark items. More...
 
ta_e_result_code_t ta_show_signature_capture_request_set_watermark_items (ta_object_t request, ta_object_t watermark_items)
 Set list of watermark items. More...
 

Function Documentation

◆ ta_show_signature_capture_request_copy()

ta_e_result_code_t ta_show_signature_capture_request_copy ( ta_object_t request,
const ta_object_t source_request 
)

Create copy of show signature capture request.

Parameters
[out]requestPointer to variable to write created object instance to. Created object instance is retained.
[in]source_requestObject of type show_signature_capture_request to create copy of.
Return values
ta_c_rc_okObject instance has been created and written to request.
ta_c_rc_invalid_argumentrequest is null-pointer.
ta_c_rc_invalid_argumentsource_request is ta_invalid_object.
ta_c_rc_invalid_argumentsource_request is not of type show_signature_capture_request.
ta_c_rc_out_of_memoryFailed allocating memory.

◆ ta_show_signature_capture_request_create()

ta_e_result_code_t ta_show_signature_capture_request_create ( ta_object_t request)

Create show signature capture request.

Parameters
[out]requestPointer 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 request.
ta_c_rc_invalid_argumentrequest is null-pointer.
ta_c_rc_out_of_memoryFailed allocating memory.

◆ ta_show_signature_capture_request_get_background_color()

ta_e_result_code_t ta_show_signature_capture_request_get_background_color ( ta_object_t  request,
ta_s_color_t background_color 
)

Background color.

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

◆ ta_show_signature_capture_request_get_brand_bar()

ta_e_result_code_t ta_show_signature_capture_request_get_brand_bar ( ta_object_t  request,
ta_object_t brand_bar 
)

Brand bar.

Used if brand mode is ta_c_bm_selected.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[out]brand_barPointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type integer. The value of the elements comes from ta_e_brand_bar_brand_t.
Return values
ta_c_rc_okObject instance written to brand_bar.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentbrand_bar is null-pointer.

◆ ta_show_signature_capture_request_get_brand_mode()

ta_e_result_code_t ta_show_signature_capture_request_get_brand_mode ( ta_object_t  request,
ta_e_brand_mode_t brand_mode 
)

Brand mode.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[out]brand_modePointer to variable to write value to. Value is ta_c_bm_undefined if value is not set in request.
Return values
ta_c_rc_okValue written to brand_mode.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentbrand_mode is null-pointer.

◆ ta_show_signature_capture_request_get_image_file_format()

ta_e_result_code_t ta_show_signature_capture_request_get_image_file_format ( ta_object_t  request,
ta_e_image_file_format_t image_file_format 
)

Image file format to use.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[out]image_file_formatPointer to variable to write value to. Value is ta_c_iff_undefined if value is not set in request.
Return values
ta_c_rc_okValue written to image_file_format.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentimage_file_format is null-pointer.

◆ ta_show_signature_capture_request_get_image_file_height()

ta_e_result_code_t ta_show_signature_capture_request_get_image_file_height ( ta_object_t  request,
int *  image_file_height 
)

Image file height in pixels.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[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_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentimage_file_height is null-pointer.

◆ ta_show_signature_capture_request_get_image_file_width()

ta_e_result_code_t ta_show_signature_capture_request_get_image_file_width ( ta_object_t  request,
int *  image_file_width 
)

Image file width in pixels.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[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_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentimage_file_width is null-pointer.

◆ ta_show_signature_capture_request_get_language()

ta_e_result_code_t ta_show_signature_capture_request_get_language ( ta_object_t  request,
ta_object_t language 
)

Language.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[out]languagePointer 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 request.
Return values
ta_c_rc_okObject instance written to language.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentlanguage is null-pointer.

◆ ta_show_signature_capture_request_get_resource_id()

ta_e_result_code_t ta_show_signature_capture_request_get_resource_id ( ta_object_t  request,
ta_e_resource_id_t resource_id 
)

Resource identifier.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[out]resource_idPointer to variable to write value to. Value is ta_c_rid_undefined if value is not set in request.
Return values
ta_c_rc_okValue written to resource_id.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentresource_id is null-pointer.

◆ ta_show_signature_capture_request_get_signature_color()

ta_e_result_code_t ta_show_signature_capture_request_get_signature_color ( ta_object_t  request,
ta_s_color_t signature_color 
)

Signature color.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[out]signature_colorPointer to variable to write value to.
Return values
ta_c_rc_okValue written to signature_color.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentsignature_color is null-pointer.

◆ ta_show_signature_capture_request_get_theme()

ta_e_result_code_t ta_show_signature_capture_request_get_theme ( ta_object_t  request,
ta_e_theme_t theme 
)

Theme.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[out]themePointer to variable to write value to. Value is ta_c_theme_undefined if value is not set in request.
Return values
ta_c_rc_okValue written to theme.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumenttheme is null-pointer.

◆ ta_show_signature_capture_request_get_timeout()

ta_e_result_code_t ta_show_signature_capture_request_get_timeout ( ta_object_t  request,
int *  timeout 
)

Timeout in seconds.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[out]timeoutPointer to variable to write value to. Value is 0 if value is not set in request.
Return values
ta_c_rc_okValue written to timeout.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumenttimeout is null-pointer.

◆ ta_show_signature_capture_request_get_watermark_color()

ta_e_result_code_t ta_show_signature_capture_request_get_watermark_color ( ta_object_t  request,
ta_s_color_t watermark_color 
)

Watermark color.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[out]watermark_colorPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to watermark_color.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentwatermark_color is null-pointer.

◆ ta_show_signature_capture_request_get_watermark_items()

ta_e_result_code_t ta_show_signature_capture_request_get_watermark_items ( ta_object_t  request,
ta_object_t watermark_items 
)

List of watermark items.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[out]watermark_itemsPointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type string.
Return values
ta_c_rc_okObject instance written to watermark_items.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentwatermark_items is null-pointer.

◆ ta_show_signature_capture_request_set_background_color()

ta_e_result_code_t ta_show_signature_capture_request_set_background_color ( ta_object_t  request,
const ta_s_color_t background_color 
)

Set background color.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]background_colorPointer to value to set.
Return values
ta_c_rc_okValue assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentbackground_color is null-pointer.

◆ ta_show_signature_capture_request_set_brand_bar()

ta_e_result_code_t ta_show_signature_capture_request_set_brand_bar ( ta_object_t  request,
ta_object_t  brand_bar 
)

Set brand bar.

Used if brand mode is ta_c_bm_selected.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]brand_barObject instance to set. Object instance has to be of type list. The list has to contain elements of type integer. The value of the elements have to match ta_e_brand_bar_brand_t.
Return values
ta_c_rc_okObject instance assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentbrand_bar is ta_invalid_object.
ta_c_rc_invalid_argumentbrand_bar is not of type list.
ta_c_rc_invalid_argumentElement in brand_bar is ta_invalid_object.
ta_c_rc_invalid_argumentElement in brand_bar is not of type integer.

◆ ta_show_signature_capture_request_set_brand_mode()

ta_e_result_code_t ta_show_signature_capture_request_set_brand_mode ( ta_object_t  request,
ta_e_brand_mode_t  brand_mode 
)

Set brand mode.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]brand_modeValue to set.
Return values
ta_c_rc_okValue assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentbrand_mode is ta_c_bm_undefined.

◆ ta_show_signature_capture_request_set_image_file_format()

ta_e_result_code_t ta_show_signature_capture_request_set_image_file_format ( ta_object_t  request,
ta_e_image_file_format_t  image_file_format 
)

Set image file format to use.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]image_file_formatValue to set.
Return values
ta_c_rc_okValue assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentimage_file_format is ta_c_iff_undefined.

◆ ta_show_signature_capture_request_set_image_file_height()

ta_e_result_code_t ta_show_signature_capture_request_set_image_file_height ( ta_object_t  request,
int  image_file_height 
)

Set image file height in pixels.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]image_file_heightValue to set.
Return values
ta_c_rc_okValue assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentimage_file_height is less than 1.

◆ ta_show_signature_capture_request_set_image_file_width()

ta_e_result_code_t ta_show_signature_capture_request_set_image_file_width ( ta_object_t  request,
int  image_file_width 
)

Set image file width in pixels.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]image_file_widthValue to set.
Return values
ta_c_rc_okValue assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentimage_file_width is less than 1.

◆ ta_show_signature_capture_request_set_language()

ta_e_result_code_t ta_show_signature_capture_request_set_language ( ta_object_t  request,
ta_object_t  language 
)

Set language.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]languageObject instance to set. Object instance can be ta_invalid_object to clear the value in request. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentlanguage is not ta_invalid_object and is not of type string.

◆ ta_show_signature_capture_request_set_resource_id()

ta_e_result_code_t ta_show_signature_capture_request_set_resource_id ( ta_object_t  request,
ta_e_resource_id_t  resource_id 
)

Set resource identifier.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]resource_idValue to set.
Return values
ta_c_rc_okValue assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentresource_id is ta_c_rid_undefined.

◆ ta_show_signature_capture_request_set_signature_color()

ta_e_result_code_t ta_show_signature_capture_request_set_signature_color ( ta_object_t  request,
const ta_s_color_t signature_color 
)

Set signature color.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]signature_colorPointer to value to set.
Return values
ta_c_rc_okValue assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentsignature_color is null-pointer.

◆ ta_show_signature_capture_request_set_theme()

ta_e_result_code_t ta_show_signature_capture_request_set_theme ( ta_object_t  request,
ta_e_theme_t  theme 
)

Set theme.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]themeValue to set.
Return values
ta_c_rc_okValue assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumenttheme is ta_c_theme_undefined.

◆ ta_show_signature_capture_request_set_timeout()

ta_e_result_code_t ta_show_signature_capture_request_set_timeout ( ta_object_t  request,
int  timeout 
)

Set timeout in seconds.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]timeoutValue to set.
Return values
ta_c_rc_okValue assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumenttimeout is ta_c_theme_undefined.
ta_c_rc_invalid_argumenttimeout is less than 0.

◆ ta_show_signature_capture_request_set_watermark_color()

ta_e_result_code_t ta_show_signature_capture_request_set_watermark_color ( ta_object_t  request,
const ta_s_color_t watermark_color 
)

Set watermark color.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]watermark_colorPointer to value to set.
Return values
ta_c_rc_okValue assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentlanguage is not null-pointer.

◆ ta_show_signature_capture_request_set_watermark_items()

ta_e_result_code_t ta_show_signature_capture_request_set_watermark_items ( ta_object_t  request,
ta_object_t  watermark_items 
)

Set list of watermark items.

Parameters
[in]requestObject instance of type show_signature_capture_request.
[in]watermark_itemsObject instance to set. Object instance has to be of type list. The list has to contain elements of type string.
Return values
ta_c_rc_okObject instance assigned to request.
ta_c_rc_invalid_argumentrequest is ta_invalid_object.
ta_c_rc_invalid_argumentrequest is not of type show_signature_capture_request.
ta_c_rc_invalid_argumentwatermark_items is ta_invalid_object.
ta_c_rc_invalid_argumentwatermark_items is not of type list.
ta_c_rc_invalid_argumentElement in watermark_items is ta_invalid_object.
ta_c_rc_invalid_argumentElement in watermark_items is not of type string.