print_option.h File Reference

Description

Print option.

Object type print_option.

Functions
ta_e_result_code_t	ta_print_option_create (ta_object_t *print_option, ta_e_recipient_t recipient, ta_e_print_format_t print_format, int print_width, int print_flags)
	Create print option. More...
ta_e_result_code_t	ta_print_option_get_recipient (ta_object_t print_option, ta_e_recipient_t *recipient)
	Target of the print option. Can be Merchant or Cardholder. More...
ta_e_result_code_t	ta_print_option_get_print_format (ta_object_t print_option, ta_e_print_format_t *print_format)
	Specifies the print format. More...
ta_e_result_code_t	ta_print_option_get_print_width (ta_object_t print_option, int *print_width)
	Specifies the print width of the receipt (default = 40). More...
ta_e_result_code_t	ta_print_option_get_print_flags (ta_object_t print_option, int *print_flags)
	Print flags as OR combined values from ta_e_print_flag_t. More...

Function Documentation

ta_print_option_create()

ta_e_result_code_t ta_print_option_create	(	ta_object_t *	print_option,
		ta_e_recipient_t	recipient,
		ta_e_print_format_t	print_format,
		int	print_width,
		int	print_flags
	)

Create print option.

Parameters

[out]	print_option	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	recipient	Recipient.
[in]	print_format	Print format.
[in]	print_width	Print width in characters.
[in]	print_flags	Print flags using OR combined values from ta_e_print_flag_t.

Return values

ta_c_rc_ok	Object instance has been created and written to print_option.
ta_c_rc_invalid_argument	print_option is null-pointer.
ta_c_rc_invalid_argument	print_width is less than 1.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_print_option_get_print_flags()

ta_e_result_code_t ta_print_option_get_print_flags	(	ta_object_t	print_option,
		int *	print_flags
	)

Print flags as OR combined values from ta_e_print_flag_t.

Parameters

[in]	print_option	Object instance of type print_option.
[out]	print_flags	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to print_flags.
ta_c_rc_invalid_argument	print_option is ta_invalid_object.
ta_c_rc_invalid_argument	print_option is not of type print_option.
ta_c_rc_invalid_argument	print_flags is null-pointer.

ta_print_option_get_print_format()

ta_e_result_code_t ta_print_option_get_print_format	(	ta_object_t	print_option,
		ta_e_print_format_t *	print_format
	)

Specifies the print format.

Parameters

[in]	print_option	Object instance of type print_option.
[out]	print_format	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to print_format.
ta_c_rc_invalid_argument	print_option is ta_invalid_object.
ta_c_rc_invalid_argument	print_option is not of type print_option.
ta_c_rc_invalid_argument	print_format is null-pointer.

ta_print_option_get_print_width()

ta_e_result_code_t ta_print_option_get_print_width	(	ta_object_t	print_option,
		int *	print_width
	)

Specifies the print width of the receipt (default = 40).

Parameters

[in]	print_option	Object instance of type print_option.
[out]	print_width	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to print_width.
ta_c_rc_invalid_argument	print_option is ta_invalid_object.
ta_c_rc_invalid_argument	print_option is not of type print_option.
ta_c_rc_invalid_argument	print_width is null-pointer.

ta_print_option_get_recipient()

ta_e_result_code_t ta_print_option_get_recipient	(	ta_object_t	print_option,
		ta_e_recipient_t *	recipient
	)

Target of the print option. Can be Merchant or Cardholder.

Parameters

[in]	print_option	Object instance of type print_option.
[out]	recipient	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to recipient.
ta_c_rc_invalid_argument	print_option is ta_invalid_object.
ta_c_rc_invalid_argument	print_option is not of type print_option.
ta_c_rc_invalid_argument	recipient is null-pointer.