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]	request	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	source_request	Object of type show_signature_capture_request to create copy of.

Return values

ta_c_rc_ok	Object instance has been created and written to request.
ta_c_rc_invalid_argument	request is null-pointer.
ta_c_rc_invalid_argument	source_request is ta_object_invalid.
ta_c_rc_invalid_argument	source_request is not of type show_signature_capture_request.
ta_c_rc_out_of_memory	Failed 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]

request

Pointer to variable to write created object instance to. Created object instance is retained.

Return values

ta_c_rc_ok	Object instance has been created and written to request.
ta_c_rc_invalid_argument	request is null-pointer.
ta_c_rc_out_of_memory	Failed 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]	request	Object instance of type show_signature_capture_request.
[out]	background_color	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to background_color.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	background_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]	request	Object instance of type show_signature_capture_request.
[out]	brand_bar	Pointer 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_ok	Object instance written to brand_bar.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	brand_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]	request	Object instance of type show_signature_capture_request.
[out]	brand_mode	Pointer to variable to write value to. Value is ta_c_bm_undefined if value is not set in request.

Return values

ta_c_rc_ok	Value written to brand_mode.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	brand_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]	request	Object instance of type show_signature_capture_request.
[out]	image_file_format	Pointer to variable to write value to. Value is ta_c_iff_undefined if value is not set in request.

Return values

ta_c_rc_ok	Value written to image_file_format.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	image_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]	request	Object instance of type show_signature_capture_request.
[out]	image_file_height	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to image_file_height.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	image_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]	request	Object instance of type show_signature_capture_request.
[out]	image_file_width	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to image_file_width.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	image_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]	request	Object instance of type show_signature_capture_request.
[out]	language	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in request.

Return values

ta_c_rc_ok	Object instance written to language.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	language 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]	request	Object instance of type show_signature_capture_request.
[out]	resource_id	Pointer to variable to write value to. Value is ta_c_rid_undefined if value is not set in request.

Return values

ta_c_rc_ok	Value written to resource_id.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	resource_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]	request	Object instance of type show_signature_capture_request.
[out]	signature_color	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to signature_color.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	signature_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]	request	Object instance of type show_signature_capture_request.
[out]	theme	Pointer to variable to write value to. Value is ta_c_theme_undefined if value is not set in request.

Return values

ta_c_rc_ok	Value written to theme.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	theme 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]	request	Object instance of type show_signature_capture_request.
[out]	timeout	Pointer to variable to write value to. Value is 0 if value is not set in request.

Return values

ta_c_rc_ok	Value written to timeout.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	timeout 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]	request	Object instance of type show_signature_capture_request.
[out]	watermark_color	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to watermark_color.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	watermark_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]	request	Object instance of type show_signature_capture_request.
[out]	watermark_items	Pointer 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_ok	Object instance written to watermark_items.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	watermark_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]	request	Object instance of type show_signature_capture_request.
[in]	background_color	Pointer to value to set.

Return values

ta_c_rc_ok	Value assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	background_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]	request	Object instance of type show_signature_capture_request.
[in]	brand_bar	Object 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_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	brand_bar is ta_object_invalid.
ta_c_rc_invalid_argument	brand_bar is not of type list.
ta_c_rc_invalid_argument	Element in brand_bar is ta_object_invalid.
ta_c_rc_invalid_argument	Element 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]	request	Object instance of type show_signature_capture_request.
[in]	brand_mode	Value to set.

Return values

ta_c_rc_ok	Value assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	brand_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]	request	Object instance of type show_signature_capture_request.
[in]	image_file_format	Value to set.

Return values

ta_c_rc_ok	Value assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	image_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]	request	Object instance of type show_signature_capture_request.
[in]	image_file_height	Value to set.

Return values

ta_c_rc_ok	Value assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	image_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]	request	Object instance of type show_signature_capture_request.
[in]	image_file_width	Value to set.

Return values

ta_c_rc_ok	Value assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	image_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]	request	Object instance of type show_signature_capture_request.
[in]	language	Object instance to set. Object instance can be ta_object_invalid to clear the value in request. If object instance is not ta_object_invalid is has to be of type string.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	language is not ta_object_invalid 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]	request	Object instance of type show_signature_capture_request.
[in]	resource_id	Value to set.

Return values

ta_c_rc_ok	Value assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	resource_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]	request	Object instance of type show_signature_capture_request.
[in]	signature_color	Pointer to value to set.

Return values

ta_c_rc_ok	Value assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	signature_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]	request	Object instance of type show_signature_capture_request.
[in]	theme	Value to set.

Return values

ta_c_rc_ok	Value assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	theme 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]	request	Object instance of type show_signature_capture_request.
[in]	timeout	Value to set.

Return values

ta_c_rc_ok	Value assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	timeout is ta_c_theme_undefined.
ta_c_rc_invalid_argument	timeout 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]	request	Object instance of type show_signature_capture_request.
[in]	watermark_color	Pointer to value to set.

Return values

ta_c_rc_ok	Value assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	language 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]	request	Object instance of type show_signature_capture_request.
[in]	watermark_items	Object 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_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	watermark_items is ta_object_invalid.
ta_c_rc_invalid_argument	watermark_items is not of type list.
ta_c_rc_invalid_argument	Element in watermark_items is ta_object_invalid.
ta_c_rc_invalid_argument	Element in watermark_items is not of type string.