Typedefs
typedef enum scanbotsdk_compression_mode_t	scanbotsdk_compression_mode_t
	scanbotsdk_compression_mode_t enum

typedef struct scanbotsdk_user_field_value_t	scanbotsdk_user_field_value_t
	scanbotsdk_user_field_value_t class

typedef struct scanbotsdk_user_field_double_value_t	scanbotsdk_user_field_double_value_t
	scanbotsdk_user_field_double_value_t class

typedef struct scanbotsdk_user_field_string_value_t	scanbotsdk_user_field_string_value_t
	scanbotsdk_user_field_string_value_t class

typedef struct scanbotsdk_user_field_int_value_t	scanbotsdk_user_field_int_value_t
	scanbotsdk_user_field_int_value_t class

typedef struct scanbotsdk_user_field_t	scanbotsdk_user_field_t
	scanbotsdk_user_field_t class

typedef struct scanbotsdk_tiff_generator_parameters_t	scanbotsdk_tiff_generator_parameters_t
	scanbotsdk_tiff_generator_parameters_t class

Enumerations
enum	scanbotsdk_compression_mode_t { SCANBOTSDK_COMPRESSION_MODE_NONE = 1 , SCANBOTSDK_COMPRESSION_MODE_CCITTRLE = 2 , SCANBOTSDK_COMPRESSION_MODE_CCITT_T4 = 3 , SCANBOTSDK_COMPRESSION_MODE_CCITT_T6 = 4 , SCANBOTSDK_COMPRESSION_MODE_LZW = 5 , SCANBOTSDK_COMPRESSION_MODE_JPEG = 7 , SCANBOTSDK_COMPRESSION_MODE_CCITTRLEW = 32771 , SCANBOTSDK_COMPRESSION_MODE_PACKBITS = 32773 , SCANBOTSDK_COMPRESSION_MODE_DEFLATE = 32946 , SCANBOTSDK_COMPRESSION_MODE_ADOBE_DEFLATE = 8 }
	scanbotsdk_compression_mode_t enum More...

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_compression_mode_t_to_string (scanbotsdk_compression_mode_t value, const char **result)
	Returns the string representation of the given scanbotsdk_compression_mode_t value.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_free (scanbotsdk_user_field_value_t *object)
	Frees the memory allocated for the instance of scanbotsdk_user_field_value_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_double_value_create (double value, scanbotsdk_user_field_double_value_t **result)
	Creates a new instance of scanbotsdk_user_field_double_value with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_double_value_free (scanbotsdk_user_field_double_value_t *object)
	Frees the memory allocated for the instance of scanbotsdk_user_field_double_value_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_is_scanbotsdk_user_field_double_value (scanbotsdk_user_field_value_t object, bool result)
	Checks if the given instance of scanbotsdk_user_field_value_t is an instance of its subtype scanbotsdk_user_field_double_value_t.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_as_scanbotsdk_user_field_double_value (scanbotsdk_user_field_value_t object, scanbotsdk_user_field_double_value_t *result)
	Casts the given instance of scanbotsdk_user_field_value_t to its subtype scanbotsdk_user_field_double_value_t. If the given instance is not an instance of the subtype, result will be null.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_double_value_as_scanbotsdk_user_field_value (scanbotsdk_user_field_double_value_t object, scanbotsdk_user_field_value_t *result)
	Casts the given instance of scanbotsdk_user_field_double_value_t to its parent type scanbotsdk_user_field_value_t.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_double_value_get_value (scanbotsdk_user_field_double_value_t self, double value)
	Returns value of value field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_double_value_set_value (scanbotsdk_user_field_double_value_t *self, double value)
	Sets value of value field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_string_value_create (const char value, scanbotsdk_user_field_string_value_t *result)
	Creates a new instance of scanbotsdk_user_field_string_value with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_string_value_free (scanbotsdk_user_field_string_value_t *object)
	Frees the memory allocated for the instance of scanbotsdk_user_field_string_value_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_is_scanbotsdk_user_field_string_value (scanbotsdk_user_field_value_t object, bool result)
	Checks if the given instance of scanbotsdk_user_field_value_t is an instance of its subtype scanbotsdk_user_field_string_value_t.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_as_scanbotsdk_user_field_string_value (scanbotsdk_user_field_value_t object, scanbotsdk_user_field_string_value_t *result)
	Casts the given instance of scanbotsdk_user_field_value_t to its subtype scanbotsdk_user_field_string_value_t. If the given instance is not an instance of the subtype, result will be null.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_string_value_as_scanbotsdk_user_field_value (scanbotsdk_user_field_string_value_t object, scanbotsdk_user_field_value_t *result)
	Casts the given instance of scanbotsdk_user_field_string_value_t to its parent type scanbotsdk_user_field_value_t.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_string_value_get_value (scanbotsdk_user_field_string_value_t self, const char *value)
	Returns value of value field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_string_value_set_value (scanbotsdk_user_field_string_value_t self, const char value)
	Sets value of value field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_int_value_create (int value, scanbotsdk_user_field_int_value_t **result)
	Creates a new instance of scanbotsdk_user_field_int_value with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_int_value_free (scanbotsdk_user_field_int_value_t *object)
	Frees the memory allocated for the instance of scanbotsdk_user_field_int_value_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_is_scanbotsdk_user_field_int_value (scanbotsdk_user_field_value_t object, bool result)
	Checks if the given instance of scanbotsdk_user_field_value_t is an instance of its subtype scanbotsdk_user_field_int_value_t.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_value_as_scanbotsdk_user_field_int_value (scanbotsdk_user_field_value_t object, scanbotsdk_user_field_int_value_t *result)
	Casts the given instance of scanbotsdk_user_field_value_t to its subtype scanbotsdk_user_field_int_value_t. If the given instance is not an instance of the subtype, result will be null.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_int_value_as_scanbotsdk_user_field_value (scanbotsdk_user_field_int_value_t object, scanbotsdk_user_field_value_t *result)
	Casts the given instance of scanbotsdk_user_field_int_value_t to its parent type scanbotsdk_user_field_value_t.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_int_value_get_value (scanbotsdk_user_field_int_value_t self, int value)
	Returns value of value field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_int_value_set_value (scanbotsdk_user_field_int_value_t *self, int value)
	Sets value of value field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_create (int tag, const char name, scanbotsdk_user_field_value_t value, scanbotsdk_user_field_t **result)
	Creates a new instance of scanbotsdk_user_field with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_free (scanbotsdk_user_field_t *object)
	Frees the memory allocated for the instance of scanbotsdk_user_field_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_get_tag (scanbotsdk_user_field_t self, int tag)
	Returns value of tag field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_set_tag (scanbotsdk_user_field_t *self, int tag)
	Sets value of tag field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_get_name (scanbotsdk_user_field_t self, const char *name)
	Returns value of name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_set_name (scanbotsdk_user_field_t self, const char name)
	Sets value of name field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_get_value (scanbotsdk_user_field_t self, scanbotsdk_user_field_value_t *value)
	Returns value of value field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_user_field_set_value (scanbotsdk_user_field_t self, scanbotsdk_user_field_value_t value)
	Sets value of value field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_create (scanbotsdk_compression_mode_t compression, int jpeg_quality, int zip_compression_level, int dpi, scanbotsdk_user_field_t *user_fields, size_t user_fields_size, scanbotsdk_parametric_filter_t binarization_filter, scanbotsdk_tiff_generator_parameters_t **result)
	Creates a new instance of scanbotsdk_tiff_generator_parameters with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_create_with_defaults (scanbotsdk_tiff_generator_parameters_t **result)
	Creates a new instance of scanbotsdk_tiff_generator_parameters_t with given required params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_free (scanbotsdk_tiff_generator_parameters_t *object)
	Frees the memory allocated for the instance of scanbotsdk_tiff_generator_parameters_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_compression (scanbotsdk_tiff_generator_parameters_t self, scanbotsdk_compression_mode_t compression)
	Returns value of compression field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_compression (scanbotsdk_tiff_generator_parameters_t *self, scanbotsdk_compression_mode_t compression)
	Sets value of compression field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_jpeg_quality (scanbotsdk_tiff_generator_parameters_t self, int jpeg_quality)
	Returns value of jpeg_quality field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_jpeg_quality (scanbotsdk_tiff_generator_parameters_t *self, int jpeg_quality)
	Sets value of jpeg_quality field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_zip_compression_level (scanbotsdk_tiff_generator_parameters_t self, int zip_compression_level)
	Returns value of zip_compression_level field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_zip_compression_level (scanbotsdk_tiff_generator_parameters_t *self, int zip_compression_level)
	Sets value of zip_compression_level field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_dpi (scanbotsdk_tiff_generator_parameters_t self, int dpi)
	Returns value of dpi field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_dpi (scanbotsdk_tiff_generator_parameters_t *self, int dpi)
	Sets value of dpi field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_user_fields (scanbotsdk_tiff_generator_parameters_t self, scanbotsdk_user_field_t *user_fields, size_t size)
	Returns value of user_fields field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_user_fields_size (scanbotsdk_tiff_generator_parameters_t self, size_t size)
	Returns size of user_fields array.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_user_fields (scanbotsdk_tiff_generator_parameters_t self, scanbotsdk_user_field_t *user_fields, size_t user_fields_size)
	Sets value of user_fields field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_get_binarization_filter (scanbotsdk_tiff_generator_parameters_t self, scanbotsdk_parametric_filter_t *binarization_filter)
	Returns value of binarization_filter field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_tiff_generator_parameters_set_binarization_filter (scanbotsdk_tiff_generator_parameters_t self, scanbotsdk_parametric_filter_t binarization_filter)
	Sets value of binarization_filter field of the given object.

Detailed Description

Typedef Documentation

◆ scanbotsdk_compression_mode_t

typedef enum scanbotsdk_compression_mode_t scanbotsdk_compression_mode_t

scanbotsdk_compression_mode_t enum

TIFF compression type.

◆ scanbotsdk_tiff_generator_parameters_t

typedef struct scanbotsdk_tiff_generator_parameters_t scanbotsdk_tiff_generator_parameters_t

scanbotsdk_tiff_generator_parameters_t class

TIFF generator parameters.

◆ scanbotsdk_user_field_double_value_t

typedef struct scanbotsdk_user_field_double_value_t scanbotsdk_user_field_double_value_t

scanbotsdk_user_field_double_value_t class

Double value (TIFF_DOUBLE).

◆ scanbotsdk_user_field_int_value_t

typedef struct scanbotsdk_user_field_int_value_t scanbotsdk_user_field_int_value_t

scanbotsdk_user_field_int_value_t class

32-bit int value (TIFF_LONG).

◆ scanbotsdk_user_field_string_value_t

typedef struct scanbotsdk_user_field_string_value_t scanbotsdk_user_field_string_value_t

scanbotsdk_user_field_string_value_t class

ASCII string value (TIFF_ASCII).

◆ scanbotsdk_user_field_t

typedef struct scanbotsdk_user_field_t scanbotsdk_user_field_t

scanbotsdk_user_field_t class

User-defined TIFF field.

◆ scanbotsdk_user_field_value_t

typedef struct scanbotsdk_user_field_value_t scanbotsdk_user_field_value_t

scanbotsdk_user_field_value_t class

User-defined TIFF field value.

Enumeration Type Documentation

◆ scanbotsdk_compression_mode_t

enum scanbotsdk_compression_mode_t

scanbotsdk_compression_mode_t enum

TIFF compression type.

Enumerator
SCANBOTSDK_COMPRESSION_MODE_NONE	Dump mode.
SCANBOTSDK_COMPRESSION_MODE_CCITTRLE	CCITT modified Huffman RLE. For binarized images only.
SCANBOTSDK_COMPRESSION_MODE_CCITT_T4	CCITT T.4 (CCITTFAX3, CCITT Group 3 fax encoding, TIFF 6 name). For binarized images only.
SCANBOTSDK_COMPRESSION_MODE_CCITT_T6	CCITT T.6 (CCITTFAX4, CCITT Group 4 fax encoding, TIFF 6 name). For binarized images only.
SCANBOTSDK_COMPRESSION_MODE_LZW	Lempel-Ziv and Welch.
SCANBOTSDK_COMPRESSION_MODE_JPEG	JPEG DCT compression.
SCANBOTSDK_COMPRESSION_MODE_CCITTRLEW	#1 w/ word alignment. For binarized images only.
SCANBOTSDK_COMPRESSION_MODE_PACKBITS	Macintosh RLE.
SCANBOTSDK_COMPRESSION_MODE_DEFLATE	Deflate compression. Legacy Deflate codec identifier.
SCANBOTSDK_COMPRESSION_MODE_ADOBE_DEFLATE	Deflate compression, as recognized by Adobe. More widely supported.

Function Documentation

◆ scanbotsdk_compression_mode_t_to_string()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_compression_mode_t_to_string	(	scanbotsdk_compression_mode_t	value,
		const char **	result )

Returns the string representation of the given scanbotsdk_compression_mode_t value.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_tiff_generator_parameters_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_create	(	scanbotsdk_compression_mode_t	compression,
		int	jpeg_quality,
		int	zip_compression_level,
		int	dpi,
		scanbotsdk_user_field_t **	user_fields,
		size_t	user_fields_size,
		scanbotsdk_parametric_filter_t *	binarization_filter,
		scanbotsdk_tiff_generator_parameters_t **	result )

Creates a new instance of scanbotsdk_tiff_generator_parameters with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

compression Compression.

Default is LZW

Parameters

jpeg_quality JPEG quality (TIFFTAG_JPEGQUALITY). Values range from 0 to 100.

Default is 80

Parameters

zip_compression_level ZIP/Deflate compression level (TIFFTAG_ZIPQUALITY). Values range from 1 to 9.

Default is 6

Parameters

dpi	DPI value.

Default is 72

Parameters

user_fields	User-defined fields. Entries of the array must not be null.
user_fields_size	Size of the array user_fields
binarization_filter	Filter to apply to the input image when adding pages with binarization. If set, the filter is applied to the input image and the resulting image is stored as a 1-bit TIFF. When storing documents it's typically best to use the BINARY_DOCUMENT_OPTIMIZED_COMPRESSION compression mode (CCITT_T6) instead of the default, as it tends to produce the smallest file sizes. If not set, simple thresholding is applied to the image, instead. The value can be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_tiff_generator_parameters_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_tiff_generator_parameters_create_with_defaults()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_create_with_defaults ( scanbotsdk_tiff_generator_parameters_t ** result )

Creates a new instance of scanbotsdk_tiff_generator_parameters_t with given required params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result Pointer to a variable that will store the created instance of scanbotsdk_tiff_generator_parameters_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_tiff_generator_parameters_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_free ( scanbotsdk_tiff_generator_parameters_t * object )

Frees the memory allocated for the instance of scanbotsdk_tiff_generator_parameters_t. If null is passed, the function does nothing.

Parameters

object Pointer to the instance of scanbotsdk_tiff_generator_parameters_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_tiff_generator_parameters_get_binarization_filter()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_binarization_filter	(	scanbotsdk_tiff_generator_parameters_t *	self,
		scanbotsdk_parametric_filter_t **	binarization_filter )

Returns value of binarization_filter field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Filter to apply to the input image when adding pages with binarization. If set, the filter is applied to the input image and the resulting image is stored as a 1-bit TIFF. When storing documents it's typically best to use the BINARY_DOCUMENT_OPTIMIZED_COMPRESSION compression mode (CCITT_T6) instead of the default, as it tends to produce the smallest file sizes. If not set, simple thresholding is applied to the image, instead.

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t
binarization_filter	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_tiff_generator_parameters_get_compression()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_compression	(	scanbotsdk_tiff_generator_parameters_t *	self,
		scanbotsdk_compression_mode_t *	compression )

Returns value of compression field of the given object.

Compression.

Default is LZW

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t
compression	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_tiff_generator_parameters_get_dpi()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_dpi	(	scanbotsdk_tiff_generator_parameters_t *	self,
		int *	dpi )

Returns value of dpi field of the given object.

DPI value.

Default is 72

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t
dpi	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_tiff_generator_parameters_get_jpeg_quality()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_jpeg_quality	(	scanbotsdk_tiff_generator_parameters_t *	self,
		int *	jpeg_quality )

Returns value of jpeg_quality field of the given object.

JPEG quality (TIFFTAG_JPEGQUALITY). Values range from 0 to 100.

Default is 80

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t
jpeg_quality	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_tiff_generator_parameters_get_user_fields()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_user_fields	(	scanbotsdk_tiff_generator_parameters_t *	self,
		scanbotsdk_user_field_t **	user_fields,
		size_t	size )

Returns value of user_fields field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

User-defined fields.

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
user_fields	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_tiff_generator_parameters_get_user_fields_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_user_fields_size	(	scanbotsdk_tiff_generator_parameters_t *	self,
		size_t *	size )

Returns size of user_fields array.

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t
size	Pointer to a variable that will store the size.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_tiff_generator_parameters_get_zip_compression_level()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_get_zip_compression_level	(	scanbotsdk_tiff_generator_parameters_t *	self,
		int *	zip_compression_level )

Returns value of zip_compression_level field of the given object.

ZIP/Deflate compression level (TIFFTAG_ZIPQUALITY). Values range from 1 to 9.

Default is 6

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t
zip_compression_level	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_tiff_generator_parameters_set_binarization_filter()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_binarization_filter	(	scanbotsdk_tiff_generator_parameters_t *	self,
		scanbotsdk_parametric_filter_t *	binarization_filter )

Sets value of binarization_filter field of the given object.

Filter to apply to the input image when adding pages with binarization. If set, the filter is applied to the input image and the resulting image is stored as a 1-bit TIFF. When storing documents it's typically best to use the BINARY_DOCUMENT_OPTIMIZED_COMPRESSION compression mode (CCITT_T6) instead of the default, as it tends to produce the smallest file sizes. If not set, simple thresholding is applied to the image, instead.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t, the field of which will be set
binarization_filter	The value to be set. Can be null.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_tiff_generator_parameters_set_compression()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_compression	(	scanbotsdk_tiff_generator_parameters_t *	self,
		scanbotsdk_compression_mode_t	compression )

Sets value of compression field of the given object.

Compression.

Default is LZW

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t, the field of which will be set
compression	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_tiff_generator_parameters_set_dpi()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_dpi	(	scanbotsdk_tiff_generator_parameters_t *	self,
		int	dpi )

Sets value of dpi field of the given object.

DPI value.

Default is 72

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t, the field of which will be set
dpi	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_tiff_generator_parameters_set_jpeg_quality()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_jpeg_quality	(	scanbotsdk_tiff_generator_parameters_t *	self,
		int	jpeg_quality )

Sets value of jpeg_quality field of the given object.

JPEG quality (TIFFTAG_JPEGQUALITY). Values range from 0 to 100.

Default is 80

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t, the field of which will be set
jpeg_quality	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_tiff_generator_parameters_set_user_fields()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_user_fields	(	scanbotsdk_tiff_generator_parameters_t *	self,
		scanbotsdk_user_field_t **	user_fields,
		size_t	user_fields_size )

Sets value of user_fields field of the given object.

User-defined fields.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t, the field of which will be set
user_fields	The value to be set.
user_fields_size	Size of the array.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_tiff_generator_parameters_set_zip_compression_level()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_tiff_generator_parameters_set_zip_compression_level	(	scanbotsdk_tiff_generator_parameters_t *	self,
		int	zip_compression_level )

Sets value of zip_compression_level field of the given object.

ZIP/Deflate compression level (TIFFTAG_ZIPQUALITY). Values range from 1 to 9.

Default is 6

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_tiff_generator_parameters_t, the field of which will be set
zip_compression_level	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_create	(	int	tag,
		const char *	name,
		scanbotsdk_user_field_value_t *	value,
		scanbotsdk_user_field_t **	result )

Creates a new instance of scanbotsdk_user_field with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

tag	Numeric tag.
name	Field name. The value must not be null.
value	Value. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_user_field_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_double_value_as_scanbotsdk_user_field_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_double_value_as_scanbotsdk_user_field_value	(	scanbotsdk_user_field_double_value_t *	object,
		scanbotsdk_user_field_value_t **	result )

Casts the given instance of scanbotsdk_user_field_double_value_t to its parent type scanbotsdk_user_field_value_t.

Parameters

object	Pointer to the instance of scanbotsdk_user_field_value_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_user_field_double_value_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_double_value_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_double_value_create	(	double	value,
		scanbotsdk_user_field_double_value_t **	result )

Creates a new instance of scanbotsdk_user_field_double_value with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

value	Value.
result	Pointer to a variable that will store the created instance of scanbotsdk_user_field_double_value_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_double_value_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_double_value_free ( scanbotsdk_user_field_double_value_t * object )

Frees the memory allocated for the instance of scanbotsdk_user_field_double_value_t. If null is passed, the function does nothing.

Parameters

object Pointer to the instance of scanbotsdk_user_field_double_value_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_double_value_get_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_double_value_get_value	(	scanbotsdk_user_field_double_value_t *	self,
		double *	value )

Returns value of value field of the given object.

Value.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_double_value_t
value	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_user_field_double_value_set_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_double_value_set_value	(	scanbotsdk_user_field_double_value_t *	self,
		double	value )

Sets value of value field of the given object.

Value.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_double_value_t, the field of which will be set
value	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_free ( scanbotsdk_user_field_t * object )

Frees the memory allocated for the instance of scanbotsdk_user_field_t. If null is passed, the function does nothing.

Parameters

object Pointer to the instance of scanbotsdk_user_field_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_get_name()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_get_name	(	scanbotsdk_user_field_t *	self,
		const char **	name )

Returns value of name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Field name.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_t
name	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_user_field_get_tag()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_get_tag	(	scanbotsdk_user_field_t *	self,
		int *	tag )

Returns value of tag field of the given object.

Numeric tag.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_t
tag	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_user_field_get_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_get_value	(	scanbotsdk_user_field_t *	self,
		scanbotsdk_user_field_value_t **	value )

Returns value of value field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Value.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_t
value	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_user_field_int_value_as_scanbotsdk_user_field_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_int_value_as_scanbotsdk_user_field_value	(	scanbotsdk_user_field_int_value_t *	object,
		scanbotsdk_user_field_value_t **	result )

Casts the given instance of scanbotsdk_user_field_int_value_t to its parent type scanbotsdk_user_field_value_t.

Parameters

object	Pointer to the instance of scanbotsdk_user_field_value_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_user_field_int_value_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_int_value_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_int_value_create	(	int	value,
		scanbotsdk_user_field_int_value_t **	result )

Creates a new instance of scanbotsdk_user_field_int_value with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

value	Value.
result	Pointer to a variable that will store the created instance of scanbotsdk_user_field_int_value_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_int_value_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_int_value_free ( scanbotsdk_user_field_int_value_t * object )

Frees the memory allocated for the instance of scanbotsdk_user_field_int_value_t. If null is passed, the function does nothing.

Parameters

object Pointer to the instance of scanbotsdk_user_field_int_value_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_int_value_get_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_int_value_get_value	(	scanbotsdk_user_field_int_value_t *	self,
		int *	value )

Returns value of value field of the given object.

Value.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_int_value_t
value	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_user_field_int_value_set_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_int_value_set_value	(	scanbotsdk_user_field_int_value_t *	self,
		int	value )

Sets value of value field of the given object.

Value.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_int_value_t, the field of which will be set
value	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_set_name()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_set_name	(	scanbotsdk_user_field_t *	self,
		const char *	name )

Sets value of name field of the given object.

Field name.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_t, the field of which will be set
name	The value to be set. Must not be null.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_set_tag()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_set_tag	(	scanbotsdk_user_field_t *	self,
		int	tag )

Sets value of tag field of the given object.

Numeric tag.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_t, the field of which will be set
tag	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_set_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_set_value	(	scanbotsdk_user_field_t *	self,
		scanbotsdk_user_field_value_t *	value )

Sets value of value field of the given object.

Value.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_t, the field of which will be set
value	The value to be set. Must not be null.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_string_value_as_scanbotsdk_user_field_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_string_value_as_scanbotsdk_user_field_value	(	scanbotsdk_user_field_string_value_t *	object,
		scanbotsdk_user_field_value_t **	result )

Casts the given instance of scanbotsdk_user_field_string_value_t to its parent type scanbotsdk_user_field_value_t.

Parameters

object	Pointer to the instance of scanbotsdk_user_field_value_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_user_field_string_value_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_string_value_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_string_value_create	(	const char *	value,
		scanbotsdk_user_field_string_value_t **	result )

Creates a new instance of scanbotsdk_user_field_string_value with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

value	Value. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_user_field_string_value_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_string_value_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_string_value_free ( scanbotsdk_user_field_string_value_t * object )

Frees the memory allocated for the instance of scanbotsdk_user_field_string_value_t. If null is passed, the function does nothing.

Parameters

object Pointer to the instance of scanbotsdk_user_field_string_value_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_string_value_get_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_string_value_get_value	(	scanbotsdk_user_field_string_value_t *	self,
		const char **	value )

Returns value of value field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Value.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_string_value_t
value	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_user_field_string_value_set_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_string_value_set_value	(	scanbotsdk_user_field_string_value_t *	self,
		const char *	value )

Sets value of value field of the given object.

Value.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_user_field_string_value_t, the field of which will be set
value	The value to be set. Must not be null.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_value_as_scanbotsdk_user_field_double_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_as_scanbotsdk_user_field_double_value	(	scanbotsdk_user_field_value_t *	object,
		scanbotsdk_user_field_double_value_t **	result )

Casts the given instance of scanbotsdk_user_field_value_t to its subtype scanbotsdk_user_field_double_value_t. If the given instance is not an instance of the subtype, result will be null.

Parameters

object	Pointer to the instance of scanbotsdk_user_field_value_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_user_field_double_value_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_value_as_scanbotsdk_user_field_int_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_as_scanbotsdk_user_field_int_value	(	scanbotsdk_user_field_value_t *	object,
		scanbotsdk_user_field_int_value_t **	result )

Casts the given instance of scanbotsdk_user_field_value_t to its subtype scanbotsdk_user_field_int_value_t. If the given instance is not an instance of the subtype, result will be null.

Parameters

object	Pointer to the instance of scanbotsdk_user_field_value_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_user_field_int_value_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_value_as_scanbotsdk_user_field_string_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_as_scanbotsdk_user_field_string_value	(	scanbotsdk_user_field_value_t *	object,
		scanbotsdk_user_field_string_value_t **	result )

Casts the given instance of scanbotsdk_user_field_value_t to its subtype scanbotsdk_user_field_string_value_t. If the given instance is not an instance of the subtype, result will be null.

Parameters

object	Pointer to the instance of scanbotsdk_user_field_value_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_user_field_string_value_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_value_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_free ( scanbotsdk_user_field_value_t * object )

Frees the memory allocated for the instance of scanbotsdk_user_field_value_t. If null is passed, the function does nothing.

Parameters

object Pointer to the instance of scanbotsdk_user_field_value_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_value_is_scanbotsdk_user_field_double_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_is_scanbotsdk_user_field_double_value	(	scanbotsdk_user_field_value_t *	object,
		bool *	result )

Checks if the given instance of scanbotsdk_user_field_value_t is an instance of its subtype scanbotsdk_user_field_double_value_t.

Parameters

object	Pointer to the instance of scanbotsdk_user_field_value_t to be checked
result	Pointer to a variable that will store the result of the check

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_value_is_scanbotsdk_user_field_int_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_is_scanbotsdk_user_field_int_value	(	scanbotsdk_user_field_value_t *	object,
		bool *	result )

Checks if the given instance of scanbotsdk_user_field_value_t is an instance of its subtype scanbotsdk_user_field_int_value_t.

Parameters

object	Pointer to the instance of scanbotsdk_user_field_value_t to be checked
result	Pointer to a variable that will store the result of the check

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_user_field_value_is_scanbotsdk_user_field_string_value()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_user_field_value_is_scanbotsdk_user_field_string_value	(	scanbotsdk_user_field_value_t *	object,
		bool *	result )

Checks if the given instance of scanbotsdk_user_field_value_t is an instance of its subtype scanbotsdk_user_field_string_value_t.

Parameters

object	Pointer to the instance of scanbotsdk_user_field_value_t to be checked
result	Pointer to a variable that will store the result of the check

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ scanbotsdk_compression_mode_t

◆ scanbotsdk_tiff_generator_parameters_t

◆ scanbotsdk_user_field_double_value_t

◆ scanbotsdk_user_field_int_value_t

◆ scanbotsdk_user_field_string_value_t

◆ scanbotsdk_user_field_t

◆ scanbotsdk_user_field_value_t

Enumeration Type Documentation

◆ scanbotsdk_compression_mode_t

Function Documentation

◆ scanbotsdk_compression_mode_t_to_string()

◆ scanbotsdk_tiff_generator_parameters_create()

◆ scanbotsdk_tiff_generator_parameters_create_with_defaults()

◆ scanbotsdk_tiff_generator_parameters_free()

◆ scanbotsdk_tiff_generator_parameters_get_binarization_filter()

◆ scanbotsdk_tiff_generator_parameters_get_compression()

◆ scanbotsdk_tiff_generator_parameters_get_dpi()

◆ scanbotsdk_tiff_generator_parameters_get_jpeg_quality()

◆ scanbotsdk_tiff_generator_parameters_get_user_fields()

◆ scanbotsdk_tiff_generator_parameters_get_user_fields_size()

◆ scanbotsdk_tiff_generator_parameters_get_zip_compression_level()

◆ scanbotsdk_tiff_generator_parameters_set_binarization_filter()

◆ scanbotsdk_tiff_generator_parameters_set_compression()

◆ scanbotsdk_tiff_generator_parameters_set_dpi()

◆ scanbotsdk_tiff_generator_parameters_set_jpeg_quality()

◆ scanbotsdk_tiff_generator_parameters_set_user_fields()

◆ scanbotsdk_tiff_generator_parameters_set_zip_compression_level()

◆ scanbotsdk_user_field_create()

◆ scanbotsdk_user_field_double_value_as_scanbotsdk_user_field_value()

◆ scanbotsdk_user_field_double_value_create()

◆ scanbotsdk_user_field_double_value_free()

◆ scanbotsdk_user_field_double_value_get_value()

◆ scanbotsdk_user_field_double_value_set_value()

◆ scanbotsdk_user_field_free()

◆ scanbotsdk_user_field_get_name()

◆ scanbotsdk_user_field_get_tag()

◆ scanbotsdk_user_field_get_value()

◆ scanbotsdk_user_field_int_value_as_scanbotsdk_user_field_value()

◆ scanbotsdk_user_field_int_value_create()

◆ scanbotsdk_user_field_int_value_free()

◆ scanbotsdk_user_field_int_value_get_value()

◆ scanbotsdk_user_field_int_value_set_value()

◆ scanbotsdk_user_field_set_name()

◆ scanbotsdk_user_field_set_tag()

◆ scanbotsdk_user_field_set_value()

◆ scanbotsdk_user_field_string_value_as_scanbotsdk_user_field_value()

◆ scanbotsdk_user_field_string_value_create()

◆ scanbotsdk_user_field_string_value_free()

◆ scanbotsdk_user_field_string_value_get_value()

◆ scanbotsdk_user_field_string_value_set_value()

◆ scanbotsdk_user_field_value_as_scanbotsdk_user_field_double_value()

◆ scanbotsdk_user_field_value_as_scanbotsdk_user_field_int_value()

◆ scanbotsdk_user_field_value_as_scanbotsdk_user_field_string_value()

◆ scanbotsdk_user_field_value_free()

◆ scanbotsdk_user_field_value_is_scanbotsdk_user_field_double_value()

◆ scanbotsdk_user_field_value_is_scanbotsdk_user_field_int_value()

◆ scanbotsdk_user_field_value_is_scanbotsdk_user_field_string_value()