Detailed Description
Typedef Documentation
◆ scanbotsdk_australia_post_customer_format_t
| typedef enum scanbotsdk_australia_post_customer_format_t scanbotsdk_australia_post_customer_format_t |
scanbotsdk_australia_post_customer_format_t enum
Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
◆ scanbotsdk_barcode_accumulation_configuration_t
| typedef struct scanbotsdk_barcode_accumulation_configuration_t scanbotsdk_barcode_accumulation_configuration_t |
scanbotsdk_barcode_accumulation_configuration_t class
Configuration for how to accumulate results.
◆ scanbotsdk_barcode_accumulation_method_t
scanbotsdk_barcode_accumulation_method_t enum
The method how to display barcodes from previous frames.
◆ scanbotsdk_barcode_document_format_t
scanbotsdk_barcode_document_format_t enum
Type of barcode document format used.
◆ scanbotsdk_barcode_document_parser_result_t
| typedef struct scanbotsdk_barcode_document_parser_result_t scanbotsdk_barcode_document_parser_result_t |
scanbotsdk_barcode_document_parser_result_t class
The result of barcode document parsing.
◆ scanbotsdk_barcode_document_parser_t
scanbotsdk_barcode_document_parser_t class
API for parsing barcode documents.
Required licence feature(s): BarcodeScanner.
◆ scanbotsdk_barcode_format_australia_post_configuration_t
| typedef struct scanbotsdk_barcode_format_australia_post_configuration_t scanbotsdk_barcode_format_australia_post_configuration_t |
scanbotsdk_barcode_format_australia_post_configuration_t class
Australia Post barcode configuration. Add to scanner configuration to scan Australia Post barcodes.
◆ scanbotsdk_barcode_format_aztec_configuration_t
| typedef struct scanbotsdk_barcode_format_aztec_configuration_t scanbotsdk_barcode_format_aztec_configuration_t |
scanbotsdk_barcode_format_aztec_configuration_t class
Aztec configuration. Add to scanner configuration to scan Aztec codes.
◆ scanbotsdk_barcode_format_codabar_configuration_t
| typedef struct scanbotsdk_barcode_format_codabar_configuration_t scanbotsdk_barcode_format_codabar_configuration_t |
scanbotsdk_barcode_format_codabar_configuration_t class
Codabar barcode configuration. Add to scanner configuration to scan Codabar barcodes.
◆ scanbotsdk_barcode_format_code_11_configuration_t
| typedef struct scanbotsdk_barcode_format_code_11_configuration_t scanbotsdk_barcode_format_code_11_configuration_t |
scanbotsdk_barcode_format_code_11_configuration_t class
Code 11 barcode configuration. Add to scanner configuration to scan Code 11 barcodes.
◆ scanbotsdk_barcode_format_code_128_configuration_t
| typedef struct scanbotsdk_barcode_format_code_128_configuration_t scanbotsdk_barcode_format_code_128_configuration_t |
scanbotsdk_barcode_format_code_128_configuration_t class
Code 128 barcode configuration. Add to scanner configuration to scan Code 128 barcodes.
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_t
| typedef struct scanbotsdk_barcode_format_code_2_of_5_configuration_t scanbotsdk_barcode_format_code_2_of_5_configuration_t |
scanbotsdk_barcode_format_code_2_of_5_configuration_t class
Configuration for all 2-of-5 barcode types (except Interleaved 2-of-5, which is handled by ItfConfig). Add to scanner configuration to scan Code 25, IATA 2-of-5 and Industrial 2-of-5 barcodes.
Industrial 2-of-5 barcodes are a subset of Code 25 barcodes. Any valid Industrial 2-of-5 barcode is also a valid Code 25 barcode.
◆ scanbotsdk_barcode_format_code_39_configuration_t
| typedef struct scanbotsdk_barcode_format_code_39_configuration_t scanbotsdk_barcode_format_code_39_configuration_t |
scanbotsdk_barcode_format_code_39_configuration_t class
Code 39 barcode and derivatives configuration. Add to scanner configuration to scan Code 39, Code 32 (Italian Pharmacode), PZN7 and PZN8 (Pharmazentralnummer) barcodes.
◆ scanbotsdk_barcode_format_code_93_configuration_t
| typedef struct scanbotsdk_barcode_format_code_93_configuration_t scanbotsdk_barcode_format_code_93_configuration_t |
scanbotsdk_barcode_format_code_93_configuration_t class
Code 93 barcode configuration. Add to scanner configuration to scan Code 93 barcodes.
◆ scanbotsdk_barcode_format_common_configuration_t
| typedef struct scanbotsdk_barcode_format_common_configuration_t scanbotsdk_barcode_format_common_configuration_t |
scanbotsdk_barcode_format_common_configuration_t class
Convenience configuration for enabling the scanning of multiple barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple barcodes.
The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.
◆ scanbotsdk_barcode_format_common_four_state_configuration_t
| typedef struct scanbotsdk_barcode_format_common_four_state_configuration_t scanbotsdk_barcode_format_common_four_state_configuration_t |
scanbotsdk_barcode_format_common_four_state_configuration_t class
Convenience configuration for enabling the scanning of multiple four-state barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple four-state codes.
The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.
◆ scanbotsdk_barcode_format_common_one_d_configuration_t
| typedef struct scanbotsdk_barcode_format_common_one_d_configuration_t scanbotsdk_barcode_format_common_one_d_configuration_t |
scanbotsdk_barcode_format_common_one_d_configuration_t class
Convenience configuration for enabling the scanning of multiple linear (1D) barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple linear (1D) barcode formats.
The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.
◆ scanbotsdk_barcode_format_common_two_d_configuration_t
| typedef struct scanbotsdk_barcode_format_common_two_d_configuration_t scanbotsdk_barcode_format_common_two_d_configuration_t |
scanbotsdk_barcode_format_common_two_d_configuration_t class
Convenience configuration for enabling the scanning of multiple 2D codes with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple 2D codes.
The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.
◆ scanbotsdk_barcode_format_configuration_base_t
| typedef struct scanbotsdk_barcode_format_configuration_base_t scanbotsdk_barcode_format_configuration_base_t |
scanbotsdk_barcode_format_configuration_base_t class
Base class for all barcode configurations.
◆ scanbotsdk_barcode_format_data_bar_configuration_t
| typedef struct scanbotsdk_barcode_format_data_bar_configuration_t scanbotsdk_barcode_format_data_bar_configuration_t |
scanbotsdk_barcode_format_data_bar_configuration_t class
GS1 DataBar barcode configuration. Add to scanner configuration to scan GS1 DataBar-14, GS1 DataBar-14 Truncated, GS1 DataBar-14 Stacked and GS1 DataBar-14 Stacked Omnidirectional barcodes.
◆ scanbotsdk_barcode_format_data_bar_expanded_configuration_t
| typedef struct scanbotsdk_barcode_format_data_bar_expanded_configuration_t scanbotsdk_barcode_format_data_bar_expanded_configuration_t |
scanbotsdk_barcode_format_data_bar_expanded_configuration_t class
GS1 DataBar Expanded barcode configuration. Add to scanner configuration to scan GS1 DataBar Expanded and GS1 DataBar Expanded Stacked barcodes.
◆ scanbotsdk_barcode_format_data_bar_limited_configuration_t
| typedef struct scanbotsdk_barcode_format_data_bar_limited_configuration_t scanbotsdk_barcode_format_data_bar_limited_configuration_t |
scanbotsdk_barcode_format_data_bar_limited_configuration_t class
GS1 DataBar Limited barcode configuration. Add to scanner configuration to scan GS1 DataBar Limited barcodes.
◆ scanbotsdk_barcode_format_data_matrix_configuration_t
| typedef struct scanbotsdk_barcode_format_data_matrix_configuration_t scanbotsdk_barcode_format_data_matrix_configuration_t |
scanbotsdk_barcode_format_data_matrix_configuration_t class
DataMatrix configuration. Add to scanner configuration to scan DataMatrix and DataMatrix rectangular extensions (DMRE) codes.
◆ scanbotsdk_barcode_format_four_state_configuration_base_t
| typedef struct scanbotsdk_barcode_format_four_state_configuration_base_t scanbotsdk_barcode_format_four_state_configuration_base_t |
scanbotsdk_barcode_format_four_state_configuration_base_t class
Base class for all four-state barcode configurations.
◆ scanbotsdk_barcode_format_gs_1_composite_configuration_t
| typedef struct scanbotsdk_barcode_format_gs_1_composite_configuration_t scanbotsdk_barcode_format_gs_1_composite_configuration_t |
scanbotsdk_barcode_format_gs_1_composite_configuration_t class
GS1 Composite configuration. Add to scanner configuration to scan GS1 Composite barcodes.
When not enabled, the individual parts of GS1 Composite barcodes will be returned as separate items, if the respective formats are enabled (UPC-A, Code 128, MicroPDF417, PDF417). Those barcode items will have their isGS1CompositePart field set to true. If GS1 Composite scanning is enabled, the individual parts are never returned, even if their respective formats are enabled, except when the linear component is a UPC or EAN barcode. In that case the linear component might still occasionally be returned as a separate result. If this situation needs to be avoided, remove the UPC and EAN formats from the enabled formats.
If GS1 Composite scanning is disabled, but GS1 message validation is enabled, then the parts of the composite barcode may fail validation and be rejected.
◆ scanbotsdk_barcode_format_itf_configuration_t
| typedef struct scanbotsdk_barcode_format_itf_configuration_t scanbotsdk_barcode_format_itf_configuration_t |
scanbotsdk_barcode_format_itf_configuration_t class
ITF (Interleaved 2-of-5) barcode configuration. Add to scanner configuration to scan Interleaved 2-of-5 (ITF) barcodes.
◆ scanbotsdk_barcode_format_japan_post_configuration_t
| typedef struct scanbotsdk_barcode_format_japan_post_configuration_t scanbotsdk_barcode_format_japan_post_configuration_t |
scanbotsdk_barcode_format_japan_post_configuration_t class
Japan Post barcode configuration. Add to scanner configuration to scan Japan Post barcodes.
◆ scanbotsdk_barcode_format_maxi_code_configuration_t
| typedef struct scanbotsdk_barcode_format_maxi_code_configuration_t scanbotsdk_barcode_format_maxi_code_configuration_t |
scanbotsdk_barcode_format_maxi_code_configuration_t class
MaxiCode configuration. Add to scanner configuration to scan MaxiCode codes.
◆ scanbotsdk_barcode_format_micro_pdf_417_configuration_t
| typedef struct scanbotsdk_barcode_format_micro_pdf_417_configuration_t scanbotsdk_barcode_format_micro_pdf_417_configuration_t |
scanbotsdk_barcode_format_micro_pdf_417_configuration_t class
MicroPDF417 configuration. Add to scanner configuration to scan MicroPDF417 codes.
◆ scanbotsdk_barcode_format_msi_plessey_configuration_t
| typedef struct scanbotsdk_barcode_format_msi_plessey_configuration_t scanbotsdk_barcode_format_msi_plessey_configuration_t |
scanbotsdk_barcode_format_msi_plessey_configuration_t class
MSI Plessey barcode configuration. Add to scanner configuration to scan MSI Plessey barcodes.
◆ scanbotsdk_barcode_format_one_d_configuration_base_t
| typedef struct scanbotsdk_barcode_format_one_d_configuration_base_t scanbotsdk_barcode_format_one_d_configuration_base_t |
scanbotsdk_barcode_format_one_d_configuration_base_t class
Base class for all linear (1D) barcode configurations.
◆ scanbotsdk_barcode_format_pdf_417_configuration_t
| typedef struct scanbotsdk_barcode_format_pdf_417_configuration_t scanbotsdk_barcode_format_pdf_417_configuration_t |
scanbotsdk_barcode_format_pdf_417_configuration_t class
PDF417 configuration. Add to scanner configuration to scan PDF417 codes.
◆ scanbotsdk_barcode_format_pharma_code_configuration_t
| typedef struct scanbotsdk_barcode_format_pharma_code_configuration_t scanbotsdk_barcode_format_pharma_code_configuration_t |
scanbotsdk_barcode_format_pharma_code_configuration_t class
PharmaCode barcode configuration. Add to scanner configuration to scan linear (1D) Laetus Pharmacode barcodes. Two-track PharmaCode scanning is configured separately through the PharmaCodeTwoTrackConfig class.
◆ scanbotsdk_barcode_format_pharma_code_two_track_configuration_t
| typedef struct scanbotsdk_barcode_format_pharma_code_two_track_configuration_t scanbotsdk_barcode_format_pharma_code_two_track_configuration_t |
scanbotsdk_barcode_format_pharma_code_two_track_configuration_t class
PHARMA_CODE_TWO_TRACK barcode configuration. Add to scanner configuration to scan Laetus two-track PharmaCode barcodes. Linear (i.e. one-track) PharmaCode scanning is configured separately through the PharmaCodeConfig class.
◆ scanbotsdk_barcode_format_qr_code_configuration_t
| typedef struct scanbotsdk_barcode_format_qr_code_configuration_t scanbotsdk_barcode_format_qr_code_configuration_t |
scanbotsdk_barcode_format_qr_code_configuration_t class
QR Code configuration. Add to scanner configuration to scan QR codes, Micro QR codes and rectangular Micro QR (rMQR) codes.
◆ scanbotsdk_barcode_format_royal_mail_configuration_t
| typedef struct scanbotsdk_barcode_format_royal_mail_configuration_t scanbotsdk_barcode_format_royal_mail_configuration_t |
scanbotsdk_barcode_format_royal_mail_configuration_t class
Royal Mail barcode configuration. Add to scanner configuration to scan Royal Mail (a.k.a. RM4SCC, CBC, BPO 4-State) barcodes.
◆ scanbotsdk_barcode_format_royal_tnt_post_configuration_t
| typedef struct scanbotsdk_barcode_format_royal_tnt_post_configuration_t scanbotsdk_barcode_format_royal_tnt_post_configuration_t |
scanbotsdk_barcode_format_royal_tnt_post_configuration_t class
Royal TNT Post barcode configuration. Add to scanner configuration to scan Royal TNT Post (a.k.a. KIX, Klant IndeX) barcodes.
◆ scanbotsdk_barcode_format_t
| typedef enum scanbotsdk_barcode_format_t scanbotsdk_barcode_format_t |
scanbotsdk_barcode_format_t enum
Enumerates barcode formats.
◆ scanbotsdk_barcode_format_two_d_configuration_base_t
| typedef struct scanbotsdk_barcode_format_two_d_configuration_base_t scanbotsdk_barcode_format_two_d_configuration_base_t |
scanbotsdk_barcode_format_two_d_configuration_base_t class
Base class for all 2D barcode configurations.
◆ scanbotsdk_barcode_format_upc_ean_configuration_t
| typedef struct scanbotsdk_barcode_format_upc_ean_configuration_t scanbotsdk_barcode_format_upc_ean_configuration_t |
scanbotsdk_barcode_format_upc_ean_configuration_t class
UPC/EAN barcode configuration. Add to scanner configuration to scan EAN-8, EAN-13, UPC-E and UPC-A barcodes.
◆ scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t
| typedef struct scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t |
scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t class
USPS Intelligent Mail barcode configuration. Add to scanner configuration to scan USPS Intelligent Mail (a.k.a. USPS OneCode, USPS-STD-11) barcodes.
◆ scanbotsdk_barcode_item_t
| typedef struct scanbotsdk_barcode_item_t scanbotsdk_barcode_item_t |
scanbotsdk_barcode_item_t class
A single barcode found in the input image. Barcodes with the same content but different locations in the image are considered separate barcodes.
◆ scanbotsdk_barcode_scanner_configuration_t
| typedef struct scanbotsdk_barcode_scanner_configuration_t scanbotsdk_barcode_scanner_configuration_t |
scanbotsdk_barcode_scanner_configuration_t class
Configuration for the barcode scanner.
◆ scanbotsdk_barcode_scanner_engine_mode_t
scanbotsdk_barcode_scanner_engine_mode_t enum
The engine mode for barcode scanning.
◆ scanbotsdk_barcode_scanner_result_t
scanbotsdk_barcode_scanner_result_t class
The result of barcode scanning.
◆ scanbotsdk_barcode_scanner_t
| typedef struct scanbotsdk_barcode_scanner_t scanbotsdk_barcode_scanner_t |
scanbotsdk_barcode_scanner_t class
API for barcode scanning.
Required licence feature(s): BarcodeScanner.
◆ scanbotsdk_character_encoding_t
scanbotsdk_character_encoding_t enum
Enumerates character encodings.
◆ scanbotsdk_gs_1_handling_t
| typedef enum scanbotsdk_gs_1_handling_t scanbotsdk_gs_1_handling_t |
scanbotsdk_gs_1_handling_t enum
GS1 message handling options. The GS1 standard defines a key-value format for business-centric data that can be encoded into many 1D and 2D barcode types. https://ref.gs1.org/standards/genspecs/
GS1 messages have two representations or formats: a human-readable format and a machine-readable format. The human-readable format uses parentheses to wrap the keys in each pair. For example, the string "(01)012345678901(37)02(3922)00278" contains three AI keys: 01, 37, and 3922. The corresponding values are 012345678901, 02, and 00278.
The machine-readable format uses the special ASCII \x1D character to terminate key-value pairs in the string in cases where the given key implies that the value is variable-length. The equivalent machine-readable string for the above example is "010123456789013702\x1D392200278". In the above example, the 01 AI key is fixed-length, so the \x1D character is not necessary. The 37 AI keys is variable-length, so the \x1D character is necessary after the value in the pair. The 3922 AI key is also variable-length, but it is the last pair in the message, so the \x1D character is not necessary at the end.
The character \x1D is UNPRINTABLE - this means that if you try to print or otherwise visualize a GS1 message containing the \x1D character, you may see a number of different results, depending on how the system handles unprintable characters. You may see a question mark, a box, an escape sequence, a space or nothing at all.
◆ scanbotsdk_msi_plessey_checksum_algorithm_t
| typedef enum scanbotsdk_msi_plessey_checksum_algorithm_t scanbotsdk_msi_plessey_checksum_algorithm_t |
scanbotsdk_msi_plessey_checksum_algorithm_t enum
Checksum algorithm for MSI_PLESSEY.
◆ scanbotsdk_range_encoding_t
| typedef struct scanbotsdk_range_encoding_t scanbotsdk_range_encoding_t |
scanbotsdk_range_encoding_t class
A character encoding for a given range of bytes.
◆ scanbotsdk_structured_append_info_t
scanbotsdk_structured_append_info_t class
The structured append mode can be used to split a message across multiple barcodes.
◆ scanbotsdk_upc_ean_extension_behavior_t
scanbotsdk_upc_ean_extension_behavior_t enum
Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
Enumeration Type Documentation
◆ scanbotsdk_australia_post_customer_format_t
scanbotsdk_australia_post_customer_format_t enum
Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
| Enumerator | |
|---|---|
| SCANBOTSDK_AUSTRALIA_POST_CUSTOMER_FORMAT_NUMERIC | Numeric. |
| SCANBOTSDK_AUSTRALIA_POST_CUSTOMER_FORMAT_ALPHA_NUMERIC | AlphaNumeric. |
◆ scanbotsdk_barcode_accumulation_method_t
scanbotsdk_barcode_accumulation_method_t enum
The method how to display barcodes from previous frames.
◆ scanbotsdk_barcode_document_format_t
scanbotsdk_barcode_document_format_t enum
Type of barcode document format used.
◆ scanbotsdk_barcode_format_t
scanbotsdk_barcode_format_t enum
Enumerates barcode formats.
◆ scanbotsdk_barcode_scanner_engine_mode_t
scanbotsdk_barcode_scanner_engine_mode_t enum
The engine mode for barcode scanning.
◆ scanbotsdk_character_encoding_t
scanbotsdk_character_encoding_t enum
Enumerates character encodings.
◆ scanbotsdk_gs_1_handling_t
scanbotsdk_gs_1_handling_t enum
GS1 message handling options. The GS1 standard defines a key-value format for business-centric data that can be encoded into many 1D and 2D barcode types. https://ref.gs1.org/standards/genspecs/
GS1 messages have two representations or formats: a human-readable format and a machine-readable format. The human-readable format uses parentheses to wrap the keys in each pair. For example, the string "(01)012345678901(37)02(3922)00278" contains three AI keys: 01, 37, and 3922. The corresponding values are 012345678901, 02, and 00278.
The machine-readable format uses the special ASCII \x1D character to terminate key-value pairs in the string in cases where the given key implies that the value is variable-length. The equivalent machine-readable string for the above example is "010123456789013702\x1D392200278". In the above example, the 01 AI key is fixed-length, so the \x1D character is not necessary. The 37 AI keys is variable-length, so the \x1D character is necessary after the value in the pair. The 3922 AI key is also variable-length, but it is the last pair in the message, so the \x1D character is not necessary at the end.
The character \x1D is UNPRINTABLE - this means that if you try to print or otherwise visualize a GS1 message containing the \x1D character, you may see a number of different results, depending on how the system handles unprintable characters. You may see a question mark, a box, an escape sequence, a space or nothing at all.
◆ scanbotsdk_msi_plessey_checksum_algorithm_t
scanbotsdk_msi_plessey_checksum_algorithm_t enum
Checksum algorithm for MSI_PLESSEY.
◆ scanbotsdk_upc_ean_extension_behavior_t
scanbotsdk_upc_ean_extension_behavior_t enum
Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
Function Documentation
◆ scanbotsdk_australia_post_customer_format_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_australia_post_customer_format_t_to_string | ( | scanbotsdk_australia_post_customer_format_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_australia_post_customer_format_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_barcode_accumulation_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_create | ( | int | accumulation_time, |
| bool | remove_unconnected_results, | ||
| scanbotsdk_barcode_accumulation_method_t | method, | ||
| scanbotsdk_barcode_accumulation_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_accumulation_configuration 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
-
accumulation_time The time in milliseconds to accumulate barcodes across multiple frames.
Default is 500
- Parameters
-
remove_unconnected_results If true, the results from previous frames that are not connected to results on the current frame will be removed. This is should be enabled when large camera movements are expected. For small camera movements, the option can be disabled.
Default is true
- Parameters
-
method The method how to display barcodes from previous frames.
Default is INTERPOLATE_BY_CAMERA
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_accumulation_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_accumulation_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_create_with_defaults | ( | scanbotsdk_barcode_accumulation_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_accumulation_configuration_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_barcode_accumulation_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_accumulation_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_free | ( | scanbotsdk_barcode_accumulation_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_accumulation_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_accumulation_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_accumulation_configuration_get_accumulation_time()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_get_accumulation_time | ( | scanbotsdk_barcode_accumulation_configuration_t * | self, |
| int * | accumulation_time ) |
Returns value of accumulation_time field of the given object.
The time in milliseconds to accumulate barcodes across multiple frames.
Default is 500
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_accumulation_configuration_t accumulation_time Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_accumulation_configuration_get_method()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_get_method | ( | scanbotsdk_barcode_accumulation_configuration_t * | self, |
| scanbotsdk_barcode_accumulation_method_t * | method ) |
Returns value of method field of the given object.
The method how to display barcodes from previous frames.
Default is INTERPOLATE_BY_CAMERA
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_accumulation_configuration_t method Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_accumulation_configuration_get_remove_unconnected_results()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_get_remove_unconnected_results | ( | scanbotsdk_barcode_accumulation_configuration_t * | self, |
| bool * | remove_unconnected_results ) |
Returns value of remove_unconnected_results field of the given object.
If true, the results from previous frames that are not connected to results on the current frame will be removed. This is should be enabled when large camera movements are expected. For small camera movements, the option can be disabled.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_accumulation_configuration_t remove_unconnected_results Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_accumulation_configuration_set_accumulation_time()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_set_accumulation_time | ( | scanbotsdk_barcode_accumulation_configuration_t * | self, |
| int | accumulation_time ) |
Sets value of accumulation_time field of the given object.
The time in milliseconds to accumulate barcodes across multiple frames.
Default is 500
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_barcode_accumulation_configuration_t, the field of which will be set accumulation_time The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_accumulation_configuration_set_method()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_set_method | ( | scanbotsdk_barcode_accumulation_configuration_t * | self, |
| scanbotsdk_barcode_accumulation_method_t | method ) |
Sets value of method field of the given object.
The method how to display barcodes from previous frames.
Default is INTERPOLATE_BY_CAMERA
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_barcode_accumulation_configuration_t, the field of which will be set method The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_accumulation_configuration_set_remove_unconnected_results()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_set_remove_unconnected_results | ( | scanbotsdk_barcode_accumulation_configuration_t * | self, |
| bool | remove_unconnected_results ) |
Sets value of remove_unconnected_results field of the given object.
If true, the results from previous frames that are not connected to results on the current frame will be removed. This is should be enabled when large camera movements are expected. For small camera movements, the option can be disabled.
Default is true
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_barcode_accumulation_configuration_t, the field of which will be set remove_unconnected_results The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_accumulation_method_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_method_t_to_string | ( | scanbotsdk_barcode_accumulation_method_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_barcode_accumulation_method_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_barcode_document_format_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_document_format_t_to_string | ( | scanbotsdk_barcode_document_format_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_barcode_document_format_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_barcode_document_parser_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_document_parser_create | ( | scanbotsdk_barcode_document_format_t * | accepted_formats, |
| size_t | accepted_formats_size, | ||
| scanbotsdk_barcode_document_parser_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_document_parser 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
-
accepted_formats The configuration to use for the barcode document parser. accepted_formats_size Size of the array accepted_formats result Pointer to a variable that will store the created instance of scanbotsdk_barcode_document_parser_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_document_parser_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_document_parser_free | ( | scanbotsdk_barcode_document_parser_t * | self | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_document_parser_t. If null is passed, the function does nothing.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_document_parser_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_document_parser_parse()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_document_parser_parse | ( | scanbotsdk_barcode_document_parser_t * | self, |
| const char * | raw_string, | ||
| scanbotsdk_barcode_document_parser_result_t ** | result ) |
Parse the given string as a barcode document.
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_barcode_document_parser_t method to be called on raw_string The string to parse as a barcode document. The value must not be null. result Pointer to a variable that will store the created instance of scanbotsdk_barcode_document_parser_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_document_parser_result_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_document_parser_result_free | ( | scanbotsdk_barcode_document_parser_result_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_document_parser_result_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_document_parser_result_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_document_parser_result_get_parsed_document()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_document_parser_result_get_parsed_document | ( | scanbotsdk_barcode_document_parser_result_t * | self, |
| scanbotsdk_generic_document_t ** | parsed_document ) |
Returns value of parsed_document field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
In case of success, the parsed document.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_document_parser_result_t parsed_document Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_document_parser_result_get_success()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_document_parser_result_get_success | ( | scanbotsdk_barcode_document_parser_result_t * | self, |
| bool * | success ) |
Returns value of success field of the given object.
True if any document was parsed.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_document_parser_result_t success Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_australia_post_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_australia_post_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_australia_post_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_australia_post_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_australia_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_australia_post_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_australia_post_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base | ( | scanbotsdk_barcode_format_australia_post_configuration_t * | object, |
| scanbotsdk_barcode_format_four_state_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_australia_post_configuration_t to its parent type scanbotsdk_barcode_format_four_state_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_australia_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_australia_post_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_australia_post_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_australia_post_customer_format_t | australia_post_customer_format, | ||
| scanbotsdk_barcode_format_australia_post_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_australia_post_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
australia_post_customer_format Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
Default is ALPHA_NUMERIC
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_australia_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_australia_post_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_australia_post_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_australia_post_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_australia_post_configuration_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_barcode_format_australia_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_australia_post_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_australia_post_configuration_free | ( | scanbotsdk_barcode_format_australia_post_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_australia_post_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_australia_post_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_australia_post_configuration_get_australia_post_customer_format()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_australia_post_configuration_get_australia_post_customer_format | ( | scanbotsdk_barcode_format_australia_post_configuration_t * | self, |
| scanbotsdk_australia_post_customer_format_t * | australia_post_customer_format ) |
Returns value of australia_post_customer_format field of the given object.
Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
Default is ALPHA_NUMERIC
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_australia_post_configuration_t australia_post_customer_format Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_australia_post_configuration_set_australia_post_customer_format()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_australia_post_configuration_set_australia_post_customer_format | ( | scanbotsdk_barcode_format_australia_post_configuration_t * | self, |
| scanbotsdk_australia_post_customer_format_t | australia_post_customer_format ) |
Sets value of australia_post_customer_format field of the given object.
Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
Default is ALPHA_NUMERIC
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_barcode_format_australia_post_configuration_t, the field of which will be set australia_post_customer_format The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_aztec_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_aztec_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_aztec_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_aztec_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_aztec_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_aztec_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_aztec_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base | ( | scanbotsdk_barcode_format_aztec_configuration_t * | object, |
| scanbotsdk_barcode_format_two_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_aztec_configuration_t to its parent type scanbotsdk_barcode_format_two_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_aztec_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_aztec_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_aztec_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| scanbotsdk_barcode_format_aztec_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_aztec_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_aztec_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_aztec_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_aztec_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_aztec_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_aztec_configuration_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_barcode_format_aztec_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_aztec_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_aztec_configuration_free | ( | scanbotsdk_barcode_format_aztec_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_aztec_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_aztec_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_aztec_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_aztec_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_aztec_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_aztec_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_aztec_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_aztec_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_aztec_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_aztec_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_codabar_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_codabar_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_codabar_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_codabar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_codabar_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_codabar_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_codabar_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_codabar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_codabar_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| int | minimum_text_length, | ||
| int | maximum_text_length, | ||
| bool | enable_one_d_blur_scanner, | ||
| bool | return_start_end, | ||
| scanbotsdk_barcode_format_codabar_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_codabar_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
minimum_text_length Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
maximum_text_length Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
enable_one_d_blur_scanner If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
return_start_end If true, return the start and end characters.
Default is false
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_codabar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_codabar_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_codabar_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_codabar_configuration_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_barcode_format_codabar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_codabar_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_free | ( | scanbotsdk_barcode_format_codabar_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_codabar_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_codabar_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_codabar_configuration_get_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_get_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_codabar_configuration_t * | self, |
| bool * | enable_one_d_blur_scanner ) |
Returns value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_codabar_configuration_t enable_one_d_blur_scanner Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_codabar_configuration_get_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_get_maximum_text_length | ( | scanbotsdk_barcode_format_codabar_configuration_t * | self, |
| int * | maximum_text_length ) |
Returns value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_codabar_configuration_t maximum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_codabar_configuration_get_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_get_minimum_text_length | ( | scanbotsdk_barcode_format_codabar_configuration_t * | self, |
| int * | minimum_text_length ) |
Returns value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_codabar_configuration_t minimum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_codabar_configuration_get_return_start_end()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_get_return_start_end | ( | scanbotsdk_barcode_format_codabar_configuration_t * | self, |
| bool * | return_start_end ) |
Returns value of return_start_end field of the given object.
If true, return the start and end characters.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_codabar_configuration_t return_start_end Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_codabar_configuration_set_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_set_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_codabar_configuration_t * | self, |
| bool | enable_one_d_blur_scanner ) |
Sets value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
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_barcode_format_codabar_configuration_t, the field of which will be set enable_one_d_blur_scanner The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_codabar_configuration_set_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_set_maximum_text_length | ( | scanbotsdk_barcode_format_codabar_configuration_t * | self, |
| int | maximum_text_length ) |
Sets value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
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_barcode_format_codabar_configuration_t, the field of which will be set maximum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_codabar_configuration_set_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_set_minimum_text_length | ( | scanbotsdk_barcode_format_codabar_configuration_t * | self, |
| int | minimum_text_length ) |
Sets value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
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_barcode_format_codabar_configuration_t, the field of which will be set minimum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_codabar_configuration_set_return_start_end()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_codabar_configuration_set_return_start_end | ( | scanbotsdk_barcode_format_codabar_configuration_t * | self, |
| bool | return_start_end ) |
Sets value of return_start_end field of the given object.
If true, return the start and end characters.
Default is false
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_barcode_format_codabar_configuration_t, the field of which will be set return_start_end The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_11_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_code_11_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_code_11_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_11_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_11_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_code_11_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_code_11_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_11_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_11_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| bool | strip_check_digits, | ||
| int | minimum_text_length, | ||
| int | maximum_text_length, | ||
| bool | checksum, | ||
| scanbotsdk_barcode_format_code_11_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_code_11_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
strip_check_digits If true, the check digits are stripped from the result.
Default is false
- Parameters
-
minimum_text_length Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
maximum_text_length Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
checksum If true, return CODE_11 barcodes only if they have a valid checksum.
Default is true
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_code_11_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_11_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_code_11_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_code_11_configuration_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_barcode_format_code_11_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_11_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_free | ( | scanbotsdk_barcode_format_code_11_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_code_11_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_code_11_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_11_configuration_get_checksum()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_get_checksum | ( | scanbotsdk_barcode_format_code_11_configuration_t * | self, |
| bool * | checksum ) |
Returns value of checksum field of the given object.
If true, return CODE_11 barcodes only if they have a valid checksum.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_11_configuration_t checksum Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_11_configuration_get_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_get_maximum_text_length | ( | scanbotsdk_barcode_format_code_11_configuration_t * | self, |
| int * | maximum_text_length ) |
Returns value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_11_configuration_t maximum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_11_configuration_get_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_get_minimum_text_length | ( | scanbotsdk_barcode_format_code_11_configuration_t * | self, |
| int * | minimum_text_length ) |
Returns value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_11_configuration_t minimum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_11_configuration_get_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_get_strip_check_digits | ( | scanbotsdk_barcode_format_code_11_configuration_t * | self, |
| bool * | strip_check_digits ) |
Returns value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_11_configuration_t strip_check_digits Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_11_configuration_set_checksum()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_set_checksum | ( | scanbotsdk_barcode_format_code_11_configuration_t * | self, |
| bool | checksum ) |
Sets value of checksum field of the given object.
If true, return CODE_11 barcodes only if they have a valid checksum.
Default is true
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_barcode_format_code_11_configuration_t, the field of which will be set checksum The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_11_configuration_set_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_set_maximum_text_length | ( | scanbotsdk_barcode_format_code_11_configuration_t * | self, |
| int | maximum_text_length ) |
Sets value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
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_barcode_format_code_11_configuration_t, the field of which will be set maximum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_11_configuration_set_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_set_minimum_text_length | ( | scanbotsdk_barcode_format_code_11_configuration_t * | self, |
| int | minimum_text_length ) |
Sets value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
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_barcode_format_code_11_configuration_t, the field of which will be set minimum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_11_configuration_set_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_11_configuration_set_strip_check_digits | ( | scanbotsdk_barcode_format_code_11_configuration_t * | self, |
| bool | strip_check_digits ) |
Sets value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
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_barcode_format_code_11_configuration_t, the field of which will be set strip_check_digits The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_128_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_code_128_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_code_128_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_128_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_128_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_code_128_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_code_128_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_128_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_128_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| int | minimum_text_length, | ||
| int | maximum_text_length, | ||
| bool | enable_one_d_blur_scanner, | ||
| scanbotsdk_barcode_format_code_128_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_code_128_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
minimum_text_length Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
maximum_text_length Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
enable_one_d_blur_scanner If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_code_128_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_128_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_code_128_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_code_128_configuration_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_barcode_format_code_128_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_128_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_free | ( | scanbotsdk_barcode_format_code_128_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_code_128_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_code_128_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_128_configuration_get_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_get_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_code_128_configuration_t * | self, |
| bool * | enable_one_d_blur_scanner ) |
Returns value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_128_configuration_t enable_one_d_blur_scanner Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_128_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_code_128_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_128_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_128_configuration_get_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_get_maximum_text_length | ( | scanbotsdk_barcode_format_code_128_configuration_t * | self, |
| int * | maximum_text_length ) |
Returns value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_128_configuration_t maximum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_128_configuration_get_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_get_minimum_text_length | ( | scanbotsdk_barcode_format_code_128_configuration_t * | self, |
| int * | minimum_text_length ) |
Returns value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_128_configuration_t minimum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_128_configuration_set_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_set_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_code_128_configuration_t * | self, |
| bool | enable_one_d_blur_scanner ) |
Sets value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
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_barcode_format_code_128_configuration_t, the field of which will be set enable_one_d_blur_scanner The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_128_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_code_128_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_code_128_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_128_configuration_set_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_set_maximum_text_length | ( | scanbotsdk_barcode_format_code_128_configuration_t * | self, |
| int | maximum_text_length ) |
Sets value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
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_barcode_format_code_128_configuration_t, the field of which will be set maximum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_128_configuration_set_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_128_configuration_set_minimum_text_length | ( | scanbotsdk_barcode_format_code_128_configuration_t * | self, |
| int | minimum_text_length ) |
Sets value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
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_barcode_format_code_128_configuration_t, the field of which will be set minimum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| bool | strip_check_digits, | ||
| int | minimum_text_length, | ||
| int | maximum_text_length, | ||
| bool | iata_2of_5, | ||
| bool | code_25, | ||
| bool | industrial_2of_5, | ||
| bool | use_iata_2_of_5_checksum, | ||
| scanbotsdk_barcode_format_code_2_of_5_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_code_2_of_5_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
strip_check_digits If true, the check digits are stripped from the result.
Default is false
- Parameters
-
minimum_text_length Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
maximum_text_length Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
iata_2of_5 If true, scan IATA 2-of-5 barcodes. If useIATA2OF5Checksum is true, only barcodes with a valid checksum are returned.
Default is true
- Parameters
-
code_25 If true, scan and return Code 25 (Code 2-of-5) barcodes. If industrial2of5 is also true, then valid Industrial 2-of-5 barcodes will preferentially be returned as such, instead of Code 25.
Default is false
- Parameters
-
industrial_2of_5 If true, scan and return valid Industrial 2-of-5 barcodes. If false, but code25 is true, Industrial 2-of-5 barcodes will be returned as Code 25 barcodes.
Default is true
- Parameters
-
use_iata_2_of_5_checksum If true, return IATA_2_OF_5 barcodes only if they have a valid check digit.
Default is true
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_code_2_of_5_configuration_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_barcode_format_code_2_of_5_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_free | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_get_code_25()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_get_code_25 | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| bool * | code_25 ) |
Returns value of code_25 field of the given object.
If true, scan and return Code 25 (Code 2-of-5) barcodes. If industrial2of5 is also true, then valid Industrial 2-of-5 barcodes will preferentially be returned as such, instead of Code 25.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t code_25 Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_get_iata_2of_5()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_get_iata_2of_5 | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| bool * | iata_2of_5 ) |
Returns value of iata_2of_5 field of the given object.
If true, scan IATA 2-of-5 barcodes. If useIATA2OF5Checksum is true, only barcodes with a valid checksum are returned.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t iata_2of_5 Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_get_industrial_2of_5()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_get_industrial_2of_5 | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| bool * | industrial_2of_5 ) |
Returns value of industrial_2of_5 field of the given object.
If true, scan and return valid Industrial 2-of-5 barcodes. If false, but code25 is true, Industrial 2-of-5 barcodes will be returned as Code 25 barcodes.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t industrial_2of_5 Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_get_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_get_maximum_text_length | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| int * | maximum_text_length ) |
Returns value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t maximum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_get_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_get_minimum_text_length | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| int * | minimum_text_length ) |
Returns value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t minimum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_get_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_get_strip_check_digits | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| bool * | strip_check_digits ) |
Returns value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t strip_check_digits Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_get_use_iata_2_of_5_checksum()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_get_use_iata_2_of_5_checksum | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| bool * | use_iata_2_of_5_checksum ) |
Returns value of use_iata_2_of_5_checksum field of the given object.
If true, return IATA_2_OF_5 barcodes only if they have a valid check digit.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t use_iata_2_of_5_checksum Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_set_code_25()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_set_code_25 | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| bool | code_25 ) |
Sets value of code_25 field of the given object.
If true, scan and return Code 25 (Code 2-of-5) barcodes. If industrial2of5 is also true, then valid Industrial 2-of-5 barcodes will preferentially be returned as such, instead of Code 25.
Default is false
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_barcode_format_code_2_of_5_configuration_t, the field of which will be set code_25 The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_set_iata_2of_5()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_set_iata_2of_5 | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| bool | iata_2of_5 ) |
Sets value of iata_2of_5 field of the given object.
If true, scan IATA 2-of-5 barcodes. If useIATA2OF5Checksum is true, only barcodes with a valid checksum are returned.
Default is true
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_barcode_format_code_2_of_5_configuration_t, the field of which will be set iata_2of_5 The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_set_industrial_2of_5()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_set_industrial_2of_5 | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| bool | industrial_2of_5 ) |
Sets value of industrial_2of_5 field of the given object.
If true, scan and return valid Industrial 2-of-5 barcodes. If false, but code25 is true, Industrial 2-of-5 barcodes will be returned as Code 25 barcodes.
Default is true
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_barcode_format_code_2_of_5_configuration_t, the field of which will be set industrial_2of_5 The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_set_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_set_maximum_text_length | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| int | maximum_text_length ) |
Sets value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
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_barcode_format_code_2_of_5_configuration_t, the field of which will be set maximum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_set_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_set_minimum_text_length | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| int | minimum_text_length ) |
Sets value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
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_barcode_format_code_2_of_5_configuration_t, the field of which will be set minimum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_set_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_set_strip_check_digits | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| bool | strip_check_digits ) |
Sets value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
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_barcode_format_code_2_of_5_configuration_t, the field of which will be set strip_check_digits The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_2_of_5_configuration_set_use_iata_2_of_5_checksum()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_2_of_5_configuration_set_use_iata_2_of_5_checksum | ( | scanbotsdk_barcode_format_code_2_of_5_configuration_t * | self, |
| bool | use_iata_2_of_5_checksum ) |
Sets value of use_iata_2_of_5_checksum field of the given object.
If true, return IATA_2_OF_5 barcodes only if they have a valid check digit.
Default is true
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_barcode_format_code_2_of_5_configuration_t, the field of which will be set use_iata_2_of_5_checksum The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_code_39_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_code_39_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_39_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_code_39_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_code_39_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_39_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| bool | strip_check_digits, | ||
| int | minimum_text_length, | ||
| int | maximum_text_length, | ||
| bool | enable_one_d_blur_scanner, | ||
| bool | code_32, | ||
| bool | code_39, | ||
| bool | pzn_7, | ||
| bool | pzn_8, | ||
| bool | try_code_39_extended_mode, | ||
| bool | use_code_39_check_digit, | ||
| scanbotsdk_barcode_format_code_39_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_code_39_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
strip_check_digits If true, the check digits are stripped from the result.
Default is false
- Parameters
-
minimum_text_length Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
maximum_text_length Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
enable_one_d_blur_scanner If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
code_32 If true, scan and return valid CODE_32 (Italian Pharmacode) barcodes. If false, CODE_32 barcodes are not decoded and are returned as CODE_39 instead.
Default is false
- Parameters
-
code_39 If true, scan CODE_39 barcodes.
Default is true
- Parameters
-
pzn_7 If true, scan PZN7 (legacy Pharmazentralnummer) barcodes. If false, PZN7 barcodes are not decoded and are returned as CODE_39 instead.
Default is true
- Parameters
-
pzn_8 If true, scan PZN8 (Pharmazentralnummer) barcodes. If false, PZN8 barcodes are not decoded and are returned as CODE_39 instead.
Default is true
- Parameters
-
try_code_39_extended_mode If true, try to scan CODE_39 in extended mode.
Default is false
- Parameters
-
use_code_39_check_digit If true, return CODE_39 barcodes only if they have a valid check digit.
Default is false
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_code_39_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_code_39_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_code_39_configuration_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_barcode_format_code_39_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_free | ( | scanbotsdk_barcode_format_code_39_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_code_39_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_get_code_32()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_get_code_32 | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool * | code_32 ) |
Returns value of code_32 field of the given object.
If true, scan and return valid CODE_32 (Italian Pharmacode) barcodes. If false, CODE_32 barcodes are not decoded and are returned as CODE_39 instead.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t code_32 Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_39_configuration_get_code_39()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_get_code_39 | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool * | code_39 ) |
Returns value of code_39 field of the given object.
If true, scan CODE_39 barcodes.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t code_39 Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_39_configuration_get_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_get_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool * | enable_one_d_blur_scanner ) |
Returns value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t enable_one_d_blur_scanner Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_39_configuration_get_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_get_maximum_text_length | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| int * | maximum_text_length ) |
Returns value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t maximum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_39_configuration_get_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_get_minimum_text_length | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| int * | minimum_text_length ) |
Returns value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t minimum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_39_configuration_get_pzn_7()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_get_pzn_7 | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool * | pzn_7 ) |
Returns value of pzn_7 field of the given object.
If true, scan PZN7 (legacy Pharmazentralnummer) barcodes. If false, PZN7 barcodes are not decoded and are returned as CODE_39 instead.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t pzn_7 Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_39_configuration_get_pzn_8()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_get_pzn_8 | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool * | pzn_8 ) |
Returns value of pzn_8 field of the given object.
If true, scan PZN8 (Pharmazentralnummer) barcodes. If false, PZN8 barcodes are not decoded and are returned as CODE_39 instead.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t pzn_8 Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_39_configuration_get_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_get_strip_check_digits | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool * | strip_check_digits ) |
Returns value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t strip_check_digits Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_39_configuration_get_try_code_39_extended_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_get_try_code_39_extended_mode | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool * | try_code_39_extended_mode ) |
Returns value of try_code_39_extended_mode field of the given object.
If true, try to scan CODE_39 in extended mode.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t try_code_39_extended_mode Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_39_configuration_get_use_code_39_check_digit()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_get_use_code_39_check_digit | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool * | use_code_39_check_digit ) |
Returns value of use_code_39_check_digit field of the given object.
If true, return CODE_39 barcodes only if they have a valid check digit.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_39_configuration_t use_code_39_check_digit Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_39_configuration_set_code_32()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_set_code_32 | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool | code_32 ) |
Sets value of code_32 field of the given object.
If true, scan and return valid CODE_32 (Italian Pharmacode) barcodes. If false, CODE_32 barcodes are not decoded and are returned as CODE_39 instead.
Default is false
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_barcode_format_code_39_configuration_t, the field of which will be set code_32 The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_set_code_39()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_set_code_39 | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool | code_39 ) |
Sets value of code_39 field of the given object.
If true, scan CODE_39 barcodes.
Default is true
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_barcode_format_code_39_configuration_t, the field of which will be set code_39 The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_set_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_set_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool | enable_one_d_blur_scanner ) |
Sets value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
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_barcode_format_code_39_configuration_t, the field of which will be set enable_one_d_blur_scanner The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_set_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_set_maximum_text_length | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| int | maximum_text_length ) |
Sets value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
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_barcode_format_code_39_configuration_t, the field of which will be set maximum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_set_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_set_minimum_text_length | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| int | minimum_text_length ) |
Sets value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
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_barcode_format_code_39_configuration_t, the field of which will be set minimum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_set_pzn_7()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_set_pzn_7 | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool | pzn_7 ) |
Sets value of pzn_7 field of the given object.
If true, scan PZN7 (legacy Pharmazentralnummer) barcodes. If false, PZN7 barcodes are not decoded and are returned as CODE_39 instead.
Default is true
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_barcode_format_code_39_configuration_t, the field of which will be set pzn_7 The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_set_pzn_8()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_set_pzn_8 | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool | pzn_8 ) |
Sets value of pzn_8 field of the given object.
If true, scan PZN8 (Pharmazentralnummer) barcodes. If false, PZN8 barcodes are not decoded and are returned as CODE_39 instead.
Default is true
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_barcode_format_code_39_configuration_t, the field of which will be set pzn_8 The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_set_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_set_strip_check_digits | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool | strip_check_digits ) |
Sets value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
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_barcode_format_code_39_configuration_t, the field of which will be set strip_check_digits The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_set_try_code_39_extended_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_set_try_code_39_extended_mode | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool | try_code_39_extended_mode ) |
Sets value of try_code_39_extended_mode field of the given object.
If true, try to scan CODE_39 in extended mode.
Default is false
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_barcode_format_code_39_configuration_t, the field of which will be set try_code_39_extended_mode The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_39_configuration_set_use_code_39_check_digit()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_39_configuration_set_use_code_39_check_digit | ( | scanbotsdk_barcode_format_code_39_configuration_t * | self, |
| bool | use_code_39_check_digit ) |
Sets value of use_code_39_check_digit field of the given object.
If true, return CODE_39 barcodes only if they have a valid check digit.
Default is false
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_barcode_format_code_39_configuration_t, the field of which will be set use_code_39_check_digit The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_93_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_code_93_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_code_93_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_93_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_93_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_code_93_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_code_93_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_93_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_93_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| bool | strip_check_digits, | ||
| int | minimum_text_length, | ||
| int | maximum_text_length, | ||
| bool | enable_one_d_blur_scanner, | ||
| scanbotsdk_barcode_format_code_93_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_code_93_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
strip_check_digits If true, the check digits are stripped from the result.
Default is false
- Parameters
-
minimum_text_length Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
maximum_text_length Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
enable_one_d_blur_scanner If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_code_93_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_93_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_code_93_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_code_93_configuration_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_barcode_format_code_93_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_93_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_free | ( | scanbotsdk_barcode_format_code_93_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_code_93_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_code_93_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_93_configuration_get_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_get_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_code_93_configuration_t * | self, |
| bool * | enable_one_d_blur_scanner ) |
Returns value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_93_configuration_t enable_one_d_blur_scanner Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_93_configuration_get_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_get_maximum_text_length | ( | scanbotsdk_barcode_format_code_93_configuration_t * | self, |
| int * | maximum_text_length ) |
Returns value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_93_configuration_t maximum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_93_configuration_get_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_get_minimum_text_length | ( | scanbotsdk_barcode_format_code_93_configuration_t * | self, |
| int * | minimum_text_length ) |
Returns value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_93_configuration_t minimum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_93_configuration_get_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_get_strip_check_digits | ( | scanbotsdk_barcode_format_code_93_configuration_t * | self, |
| bool * | strip_check_digits ) |
Returns value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_code_93_configuration_t strip_check_digits Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_code_93_configuration_set_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_set_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_code_93_configuration_t * | self, |
| bool | enable_one_d_blur_scanner ) |
Sets value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
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_barcode_format_code_93_configuration_t, the field of which will be set enable_one_d_blur_scanner The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_93_configuration_set_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_set_maximum_text_length | ( | scanbotsdk_barcode_format_code_93_configuration_t * | self, |
| int | maximum_text_length ) |
Sets value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
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_barcode_format_code_93_configuration_t, the field of which will be set maximum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_93_configuration_set_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_set_minimum_text_length | ( | scanbotsdk_barcode_format_code_93_configuration_t * | self, |
| int | minimum_text_length ) |
Sets value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
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_barcode_format_code_93_configuration_t, the field of which will be set minimum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_code_93_configuration_set_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_code_93_configuration_set_strip_check_digits | ( | scanbotsdk_barcode_format_code_93_configuration_t * | self, |
| bool | strip_check_digits ) |
Sets value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
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_barcode_format_code_93_configuration_t, the field of which will be set strip_check_digits The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_common_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_common_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_common_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| bool | strip_check_digits, | ||
| int | minimum_text_length, | ||
| int | maximum_text_length, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| bool | strict_mode, | ||
| bool | enable_one_d_blur_scanner, | ||
| scanbotsdk_barcode_format_t * | formats, | ||
| size_t | formats_size, | ||
| scanbotsdk_barcode_format_common_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_common_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
strip_check_digits If true, the check digits are stripped from the result.
Default is false
- Parameters
-
minimum_text_length Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
maximum_text_length Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
strict_mode If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
enable_one_d_blur_scanner If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
formats List of barcode formats to scan. By default, the most commonly used formats are enabled. formats_size Size of the array formats result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_common_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_common_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_common_configuration_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_barcode_format_common_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_free | ( | scanbotsdk_barcode_format_common_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_common_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_get_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_get_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| bool * | enable_one_d_blur_scanner ) |
Returns value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t enable_one_d_blur_scanner Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_configuration_get_formats()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_get_formats | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| scanbotsdk_barcode_format_t ** | formats ) |
Returns value of formats field of the given object. The returned value is direct view into memory, no pre-allocations needed.
List of barcode formats to scan. By default, the most commonly used formats are enabled.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t formats Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_configuration_get_formats_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_get_formats_size | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| size_t * | size ) |
Returns size of formats array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_configuration_get_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_get_maximum_text_length | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| int * | maximum_text_length ) |
Returns value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t maximum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_configuration_get_minimum_1_d_confirmation_count()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_get_minimum_1_d_confirmation_count | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| int * | minimum_1_d_confirmation_count ) |
Returns value of minimum_1_d_confirmation_count field of the given object.
In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t minimum_1_d_confirmation_count Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_configuration_get_minimum_1_d_quiet_zone_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_get_minimum_1_d_quiet_zone_size | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| int * | minimum_1_d_quiet_zone_size ) |
Returns value of minimum_1_d_quiet_zone_size field of the given object.
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t minimum_1_d_quiet_zone_size Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_configuration_get_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_get_minimum_text_length | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| int * | minimum_text_length ) |
Returns value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t minimum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_configuration_get_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_get_strict_mode | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| bool * | strict_mode ) |
Returns value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t strict_mode Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_configuration_get_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_get_strip_check_digits | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| bool * | strip_check_digits ) |
Returns value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_configuration_t strip_check_digits Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_configuration_set_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_set_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| bool | enable_one_d_blur_scanner ) |
Sets value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
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_barcode_format_common_configuration_t, the field of which will be set enable_one_d_blur_scanner The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_set_formats()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_set_formats | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| scanbotsdk_barcode_format_t * | formats, | ||
| size_t | formats_size ) |
Sets value of formats field of the given object.
List of barcode formats to scan. By default, the most commonly used formats are enabled.
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_barcode_format_common_configuration_t, the field of which will be set formats The value to be set. formats_size Size of the array.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_common_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_set_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_set_maximum_text_length | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| int | maximum_text_length ) |
Sets value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
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_barcode_format_common_configuration_t, the field of which will be set maximum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_set_minimum_1_d_confirmation_count()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_set_minimum_1_d_confirmation_count | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| int | minimum_1_d_confirmation_count ) |
Sets value of minimum_1_d_confirmation_count field of the given object.
In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
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_barcode_format_common_configuration_t, the field of which will be set minimum_1_d_confirmation_count The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_set_minimum_1_d_quiet_zone_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_set_minimum_1_d_quiet_zone_size | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| int | minimum_1_d_quiet_zone_size ) |
Sets value of minimum_1_d_quiet_zone_size field of the given object.
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
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_barcode_format_common_configuration_t, the field of which will be set minimum_1_d_quiet_zone_size The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_set_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_set_minimum_text_length | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| int | minimum_text_length ) |
Sets value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
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_barcode_format_common_configuration_t, the field of which will be set minimum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_set_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_set_strict_mode | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| bool | strict_mode ) |
Sets value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
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_barcode_format_common_configuration_t, the field of which will be set strict_mode The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_configuration_set_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_configuration_set_strip_check_digits | ( | scanbotsdk_barcode_format_common_configuration_t * | self, |
| bool | strip_check_digits ) |
Sets value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
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_barcode_format_common_configuration_t, the field of which will be set strip_check_digits The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_four_state_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_four_state_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_common_four_state_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_common_four_state_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_common_four_state_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_four_state_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_four_state_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_barcode_format_t * | formats, | ||
| size_t | formats_size, | ||
| scanbotsdk_barcode_format_common_four_state_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_common_four_state_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
formats List of four-state barcode formats to scan. formats_size Size of the array formats result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_common_four_state_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_four_state_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_four_state_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_common_four_state_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_common_four_state_configuration_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_barcode_format_common_four_state_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_four_state_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_four_state_configuration_free | ( | scanbotsdk_barcode_format_common_four_state_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_common_four_state_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_common_four_state_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_four_state_configuration_get_formats()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_four_state_configuration_get_formats | ( | scanbotsdk_barcode_format_common_four_state_configuration_t * | self, |
| scanbotsdk_barcode_format_t ** | formats ) |
Returns value of formats field of the given object. The returned value is direct view into memory, no pre-allocations needed.
List of four-state barcode formats to scan.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_four_state_configuration_t formats Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_four_state_configuration_get_formats_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_four_state_configuration_get_formats_size | ( | scanbotsdk_barcode_format_common_four_state_configuration_t * | self, |
| size_t * | size ) |
Returns size of formats array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_four_state_configuration_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_four_state_configuration_set_formats()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_four_state_configuration_set_formats | ( | scanbotsdk_barcode_format_common_four_state_configuration_t * | self, |
| scanbotsdk_barcode_format_t * | formats, | ||
| size_t | formats_size ) |
Sets value of formats field of the given object.
List of four-state barcode formats to scan.
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_barcode_format_common_four_state_configuration_t, the field of which will be set formats The value to be set. formats_size Size of the array.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_common_one_d_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_common_one_d_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| bool | strip_check_digits, | ||
| int | minimum_text_length, | ||
| int | maximum_text_length, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| bool | enable_one_d_blur_scanner, | ||
| scanbotsdk_barcode_format_t * | formats, | ||
| size_t | formats_size, | ||
| scanbotsdk_barcode_format_common_one_d_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_common_one_d_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
strip_check_digits If true, the check digits are stripped from the result.
Default is false
- Parameters
-
minimum_text_length Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
maximum_text_length Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
enable_one_d_blur_scanner If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
formats List of linear (1D) barcode formats to scan. formats_size Size of the array formats result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_common_one_d_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_common_one_d_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_common_one_d_configuration_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_barcode_format_common_one_d_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_free | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_common_one_d_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_common_one_d_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_get_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_get_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| bool * | enable_one_d_blur_scanner ) |
Returns value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_one_d_configuration_t enable_one_d_blur_scanner Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_one_d_configuration_get_formats()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_get_formats | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| scanbotsdk_barcode_format_t ** | formats ) |
Returns value of formats field of the given object. The returned value is direct view into memory, no pre-allocations needed.
List of linear (1D) barcode formats to scan.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_one_d_configuration_t formats Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_one_d_configuration_get_formats_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_get_formats_size | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| size_t * | size ) |
Returns size of formats array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_one_d_configuration_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_one_d_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_one_d_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_one_d_configuration_get_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_get_maximum_text_length | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| int * | maximum_text_length ) |
Returns value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_one_d_configuration_t maximum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_one_d_configuration_get_minimum_1_d_confirmation_count()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_get_minimum_1_d_confirmation_count | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| int * | minimum_1_d_confirmation_count ) |
Returns value of minimum_1_d_confirmation_count field of the given object.
In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_one_d_configuration_t minimum_1_d_confirmation_count Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_one_d_configuration_get_minimum_1_d_quiet_zone_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_get_minimum_1_d_quiet_zone_size | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| int * | minimum_1_d_quiet_zone_size ) |
Returns value of minimum_1_d_quiet_zone_size field of the given object.
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_one_d_configuration_t minimum_1_d_quiet_zone_size Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_one_d_configuration_get_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_get_minimum_text_length | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| int * | minimum_text_length ) |
Returns value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_one_d_configuration_t minimum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_one_d_configuration_get_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_get_strip_check_digits | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| bool * | strip_check_digits ) |
Returns value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_one_d_configuration_t strip_check_digits Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_one_d_configuration_set_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_set_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| bool | enable_one_d_blur_scanner ) |
Sets value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
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_barcode_format_common_one_d_configuration_t, the field of which will be set enable_one_d_blur_scanner The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_set_formats()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_set_formats | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| scanbotsdk_barcode_format_t * | formats, | ||
| size_t | formats_size ) |
Sets value of formats field of the given object.
List of linear (1D) barcode formats to scan.
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_barcode_format_common_one_d_configuration_t, the field of which will be set formats The value to be set. formats_size Size of the array.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_common_one_d_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_set_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_set_maximum_text_length | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| int | maximum_text_length ) |
Sets value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
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_barcode_format_common_one_d_configuration_t, the field of which will be set maximum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_set_minimum_1_d_confirmation_count()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_set_minimum_1_d_confirmation_count | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| int | minimum_1_d_confirmation_count ) |
Sets value of minimum_1_d_confirmation_count field of the given object.
In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
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_barcode_format_common_one_d_configuration_t, the field of which will be set minimum_1_d_confirmation_count The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_set_minimum_1_d_quiet_zone_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_set_minimum_1_d_quiet_zone_size | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| int | minimum_1_d_quiet_zone_size ) |
Sets value of minimum_1_d_quiet_zone_size field of the given object.
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
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_barcode_format_common_one_d_configuration_t, the field of which will be set minimum_1_d_quiet_zone_size The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_set_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_set_minimum_text_length | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| int | minimum_text_length ) |
Sets value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
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_barcode_format_common_one_d_configuration_t, the field of which will be set minimum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_one_d_configuration_set_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_one_d_configuration_set_strip_check_digits | ( | scanbotsdk_barcode_format_common_one_d_configuration_t * | self, |
| bool | strip_check_digits ) |
Sets value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
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_barcode_format_common_one_d_configuration_t, the field of which will be set strip_check_digits The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_two_d_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_common_two_d_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_common_two_d_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_common_two_d_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_two_d_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| bool | strict_mode, | ||
| scanbotsdk_barcode_format_t * | formats, | ||
| size_t | formats_size, | ||
| scanbotsdk_barcode_format_common_two_d_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_common_two_d_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
strict_mode If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
formats List of 2D codes to scan. formats_size Size of the array formats result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_common_two_d_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_two_d_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_common_two_d_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_common_two_d_configuration_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_barcode_format_common_two_d_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_two_d_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_free | ( | scanbotsdk_barcode_format_common_two_d_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_common_two_d_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_common_two_d_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_two_d_configuration_get_formats()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_get_formats | ( | scanbotsdk_barcode_format_common_two_d_configuration_t * | self, |
| scanbotsdk_barcode_format_t ** | formats ) |
Returns value of formats field of the given object. The returned value is direct view into memory, no pre-allocations needed.
List of 2D codes to scan.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_two_d_configuration_t formats Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_two_d_configuration_get_formats_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_get_formats_size | ( | scanbotsdk_barcode_format_common_two_d_configuration_t * | self, |
| size_t * | size ) |
Returns size of formats array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_two_d_configuration_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_two_d_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_common_two_d_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_two_d_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_two_d_configuration_get_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_get_strict_mode | ( | scanbotsdk_barcode_format_common_two_d_configuration_t * | self, |
| bool * | strict_mode ) |
Returns value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_common_two_d_configuration_t strict_mode Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_common_two_d_configuration_set_formats()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_set_formats | ( | scanbotsdk_barcode_format_common_two_d_configuration_t * | self, |
| scanbotsdk_barcode_format_t * | formats, | ||
| size_t | formats_size ) |
Sets value of formats field of the given object.
List of 2D codes to scan.
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_barcode_format_common_two_d_configuration_t, the field of which will be set formats The value to be set. formats_size Size of the array.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_two_d_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_common_two_d_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_common_two_d_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_common_two_d_configuration_set_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_common_two_d_configuration_set_strict_mode | ( | scanbotsdk_barcode_format_common_two_d_configuration_t * | self, |
| bool | strict_mode ) |
Sets value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
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_barcode_format_common_two_d_configuration_t, the field of which will be set strict_mode The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_australia_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_australia_post_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_australia_post_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_australia_post_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_australia_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_aztec_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_aztec_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_aztec_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_aztec_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_aztec_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_codabar_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_codabar_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_codabar_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_codabar_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_codabar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_code_11_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_code_11_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_code_11_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_code_11_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_11_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_code_128_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_code_128_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_code_128_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_code_128_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_128_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_code_2_of_5_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_code_2_of_5_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_code_2_of_5_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_code_2_of_5_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_code_39_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_code_39_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_code_39_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_code_39_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_39_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_code_93_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_code_93_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_code_93_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_code_93_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_93_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_common_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_common_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_common_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_common_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_common_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_common_four_state_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_common_four_state_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_common_four_state_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_common_four_state_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_common_four_state_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_common_one_d_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_common_one_d_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_common_one_d_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_common_one_d_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_common_one_d_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_common_two_d_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_common_two_d_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_common_two_d_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_common_two_d_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_common_two_d_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_data_bar_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_data_bar_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_data_bar_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_data_bar_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_data_bar_expanded_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_data_bar_expanded_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_data_bar_expanded_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_data_bar_expanded_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_data_bar_limited_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_data_bar_limited_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_data_bar_limited_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_data_bar_limited_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_limited_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_data_matrix_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_data_matrix_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_data_matrix_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_data_matrix_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_matrix_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_four_state_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_four_state_configuration_base | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_four_state_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_four_state_configuration_base_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_four_state_configuration_base_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_gs_1_composite_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_gs_1_composite_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_gs_1_composite_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_gs_1_composite_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_gs_1_composite_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_itf_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_itf_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_itf_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_itf_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_itf_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_japan_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_japan_post_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_japan_post_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_japan_post_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_japan_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_maxi_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_maxi_code_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_maxi_code_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_maxi_code_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_maxi_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_micro_pdf_417_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_micro_pdf_417_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_micro_pdf_417_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_micro_pdf_417_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_msi_plessey_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_msi_plessey_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_msi_plessey_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_msi_plessey_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_msi_plessey_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_one_d_configuration_base_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_one_d_configuration_base_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_pdf_417_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_pdf_417_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_pdf_417_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_pdf_417_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_pharma_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_pharma_code_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_pharma_code_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_pharma_code_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pharma_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_pharma_code_two_track_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_pharma_code_two_track_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_pharma_code_two_track_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_pharma_code_two_track_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_qr_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_qr_code_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_qr_code_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_qr_code_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_qr_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_royal_mail_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_royal_mail_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_royal_mail_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_royal_mail_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_royal_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_royal_tnt_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_royal_tnt_post_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_royal_tnt_post_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_royal_tnt_post_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_royal_tnt_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_two_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_two_d_configuration_base | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_two_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_two_d_configuration_base_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_two_d_configuration_base_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_upc_ean_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_upc_ean_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_upc_ean_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_upc_ean_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_upc_ean_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_usps_intelligent_mail_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_as_scanbotsdk_barcode_format_usps_intelligent_mail_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_configuration_base_t to its subtype scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_free | ( | scanbotsdk_barcode_format_configuration_base_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_configuration_base_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_get_add_additional_quiet_zone()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_get_add_additional_quiet_zone | ( | scanbotsdk_barcode_format_configuration_base_t * | self, |
| bool * | add_additional_quiet_zone ) |
Returns value of add_additional_quiet_zone field of the given object.
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t add_additional_quiet_zone Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_configuration_base_get_minimum_size_score()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_get_minimum_size_score | ( | scanbotsdk_barcode_format_configuration_base_t * | self, |
| double * | minimum_size_score ) |
Returns value of minimum_size_score field of the given object.
Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t minimum_size_score Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_configuration_base_get_regex_filter()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_get_regex_filter | ( | scanbotsdk_barcode_format_configuration_base_t * | self, |
| const char ** | regex_filter ) |
Returns value of regex_filter field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is ""
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t regex_filter Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_australia_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_australia_post_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_australia_post_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_aztec_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_aztec_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_aztec_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_codabar_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_codabar_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_codabar_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_code_11_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_code_11_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_code_11_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_code_128_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_code_128_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_code_128_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_code_2_of_5_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_code_2_of_5_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_code_2_of_5_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_code_39_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_code_39_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_code_39_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_code_93_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_code_93_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_code_93_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_common_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_common_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_common_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_common_four_state_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_common_four_state_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_common_four_state_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_common_one_d_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_common_one_d_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_common_one_d_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_common_two_d_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_common_two_d_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_common_two_d_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_data_bar_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_data_bar_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_data_bar_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_data_bar_expanded_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_data_bar_expanded_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_data_bar_expanded_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_data_bar_limited_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_data_bar_limited_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_data_bar_limited_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_data_matrix_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_data_matrix_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_data_matrix_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_four_state_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_four_state_configuration_base | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_four_state_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_gs_1_composite_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_gs_1_composite_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_gs_1_composite_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_itf_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_itf_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_itf_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_japan_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_japan_post_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_japan_post_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_maxi_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_maxi_code_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_maxi_code_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_micro_pdf_417_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_micro_pdf_417_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_micro_pdf_417_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_msi_plessey_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_msi_plessey_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_msi_plessey_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_pdf_417_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_pdf_417_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_pdf_417_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_pharma_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_pharma_code_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_pharma_code_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_pharma_code_two_track_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_pharma_code_two_track_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_pharma_code_two_track_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_qr_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_qr_code_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_qr_code_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_royal_mail_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_royal_mail_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_royal_mail_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_royal_tnt_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_royal_tnt_post_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_royal_tnt_post_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_two_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_two_d_configuration_base | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_two_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_upc_ean_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_upc_ean_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_upc_ean_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_is_scanbotsdk_barcode_format_usps_intelligent_mail_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_is_scanbotsdk_barcode_format_usps_intelligent_mail_configuration | ( | scanbotsdk_barcode_format_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_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_barcode_format_configuration_base_set_add_additional_quiet_zone()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_set_add_additional_quiet_zone | ( | scanbotsdk_barcode_format_configuration_base_t * | self, |
| bool | add_additional_quiet_zone ) |
Sets value of add_additional_quiet_zone field of the given object.
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
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_barcode_format_configuration_base_t, the field of which will be set add_additional_quiet_zone The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_set_minimum_size_score()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_set_minimum_size_score | ( | scanbotsdk_barcode_format_configuration_base_t * | self, |
| double | minimum_size_score ) |
Sets value of minimum_size_score field of the given object.
Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
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_barcode_format_configuration_base_t, the field of which will be set minimum_size_score The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_configuration_base_set_regex_filter()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_configuration_base_set_regex_filter | ( | scanbotsdk_barcode_format_configuration_base_t * | self, |
| const char * | regex_filter ) |
Sets value of regex_filter field of the given object.
Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is ""
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_barcode_format_configuration_base_t, the field of which will be set regex_filter The value to be set. Must not be null.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_data_bar_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_data_bar_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_data_bar_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_data_bar_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| scanbotsdk_barcode_format_data_bar_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_data_bar_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_data_bar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_data_bar_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_data_bar_configuration_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_barcode_format_data_bar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_configuration_free | ( | scanbotsdk_barcode_format_data_bar_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_data_bar_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_data_bar_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_data_bar_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_data_bar_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_data_bar_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_data_bar_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_data_bar_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_expanded_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_expanded_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_data_bar_expanded_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_expanded_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_expanded_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_data_bar_expanded_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_expanded_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_expanded_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| scanbotsdk_barcode_format_data_bar_expanded_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_data_bar_expanded_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_expanded_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_expanded_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_data_bar_expanded_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_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_barcode_format_data_bar_expanded_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_expanded_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_expanded_configuration_free | ( | scanbotsdk_barcode_format_data_bar_expanded_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_expanded_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_expanded_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_data_bar_expanded_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_data_bar_expanded_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_expanded_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_data_bar_expanded_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_data_bar_expanded_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_limited_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_limited_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_data_bar_limited_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_data_bar_limited_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_limited_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_limited_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_limited_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_data_bar_limited_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_data_bar_limited_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_limited_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_limited_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_limited_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| scanbotsdk_barcode_format_data_bar_limited_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_data_bar_limited_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_data_bar_limited_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_limited_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_limited_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_data_bar_limited_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_data_bar_limited_configuration_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_barcode_format_data_bar_limited_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_limited_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_limited_configuration_free | ( | scanbotsdk_barcode_format_data_bar_limited_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_data_bar_limited_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_data_bar_limited_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_bar_limited_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_limited_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_data_bar_limited_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_data_bar_limited_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_data_bar_limited_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_bar_limited_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_data_bar_limited_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_data_bar_limited_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_matrix_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_matrix_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_data_matrix_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_data_matrix_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_matrix_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_matrix_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_matrix_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base | ( | scanbotsdk_barcode_format_data_matrix_configuration_t * | object, |
| scanbotsdk_barcode_format_two_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_data_matrix_configuration_t to its parent type scanbotsdk_barcode_format_two_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_matrix_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_matrix_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_matrix_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| scanbotsdk_barcode_format_data_matrix_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_data_matrix_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_data_matrix_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_matrix_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_matrix_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_data_matrix_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_data_matrix_configuration_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_barcode_format_data_matrix_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_matrix_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_matrix_configuration_free | ( | scanbotsdk_barcode_format_data_matrix_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_data_matrix_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_data_matrix_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_data_matrix_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_matrix_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_data_matrix_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_data_matrix_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_data_matrix_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_data_matrix_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_data_matrix_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_data_matrix_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_australia_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_australia_post_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| scanbotsdk_barcode_format_australia_post_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t to its subtype scanbotsdk_barcode_format_australia_post_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_australia_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_four_state_configuration_base_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_japan_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_japan_post_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| scanbotsdk_barcode_format_japan_post_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t to its subtype scanbotsdk_barcode_format_japan_post_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_japan_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_pharma_code_two_track_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_pharma_code_two_track_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| scanbotsdk_barcode_format_pharma_code_two_track_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t to its subtype scanbotsdk_barcode_format_pharma_code_two_track_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_royal_mail_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_royal_mail_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| scanbotsdk_barcode_format_royal_mail_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t to its subtype scanbotsdk_barcode_format_royal_mail_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_royal_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_royal_tnt_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_royal_tnt_post_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| scanbotsdk_barcode_format_royal_tnt_post_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t to its subtype scanbotsdk_barcode_format_royal_tnt_post_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_royal_tnt_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_usps_intelligent_mail_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_as_scanbotsdk_barcode_format_usps_intelligent_mail_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t to its subtype scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_four_state_configuration_base_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_free | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_four_state_configuration_base_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_australia_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_australia_post_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_australia_post_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_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_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_japan_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_japan_post_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_japan_post_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_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_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_pharma_code_two_track_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_pharma_code_two_track_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_pharma_code_two_track_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_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_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_royal_mail_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_royal_mail_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_royal_mail_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_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_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_royal_tnt_post_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_royal_tnt_post_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_royal_tnt_post_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_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_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_usps_intelligent_mail_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_four_state_configuration_base_is_scanbotsdk_barcode_format_usps_intelligent_mail_configuration | ( | scanbotsdk_barcode_format_four_state_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_four_state_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_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_barcode_format_gs_1_composite_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_gs_1_composite_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_gs_1_composite_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_gs_1_composite_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_gs_1_composite_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_gs_1_composite_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_gs_1_composite_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| bool | strict_mode, | ||
| scanbotsdk_barcode_format_gs_1_composite_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_gs_1_composite_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
strict_mode If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_gs_1_composite_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_gs_1_composite_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_gs_1_composite_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_gs_1_composite_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_gs_1_composite_configuration_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_barcode_format_gs_1_composite_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_gs_1_composite_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_gs_1_composite_configuration_free | ( | scanbotsdk_barcode_format_gs_1_composite_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_gs_1_composite_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_gs_1_composite_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_gs_1_composite_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_gs_1_composite_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_gs_1_composite_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_gs_1_composite_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_gs_1_composite_configuration_get_minimum_1_d_quiet_zone_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_gs_1_composite_configuration_get_minimum_1_d_quiet_zone_size | ( | scanbotsdk_barcode_format_gs_1_composite_configuration_t * | self, |
| int * | minimum_1_d_quiet_zone_size ) |
Returns value of minimum_1_d_quiet_zone_size field of the given object.
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_gs_1_composite_configuration_t minimum_1_d_quiet_zone_size Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_gs_1_composite_configuration_get_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_gs_1_composite_configuration_get_strict_mode | ( | scanbotsdk_barcode_format_gs_1_composite_configuration_t * | self, |
| bool * | strict_mode ) |
Returns value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_gs_1_composite_configuration_t strict_mode Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_gs_1_composite_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_gs_1_composite_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_gs_1_composite_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_gs_1_composite_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_gs_1_composite_configuration_set_minimum_1_d_quiet_zone_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_gs_1_composite_configuration_set_minimum_1_d_quiet_zone_size | ( | scanbotsdk_barcode_format_gs_1_composite_configuration_t * | self, |
| int | minimum_1_d_quiet_zone_size ) |
Sets value of minimum_1_d_quiet_zone_size field of the given object.
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
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_barcode_format_gs_1_composite_configuration_t, the field of which will be set minimum_1_d_quiet_zone_size The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_gs_1_composite_configuration_set_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_gs_1_composite_configuration_set_strict_mode | ( | scanbotsdk_barcode_format_gs_1_composite_configuration_t * | self, |
| bool | strict_mode ) |
Sets value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
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_barcode_format_gs_1_composite_configuration_t, the field of which will be set strict_mode The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_itf_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_itf_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_itf_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_itf_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_itf_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_itf_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_itf_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_itf_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_itf_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| int | minimum_text_length, | ||
| int | maximum_text_length, | ||
| bool | enable_one_d_blur_scanner, | ||
| scanbotsdk_barcode_format_itf_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_itf_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
minimum_text_length Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
maximum_text_length Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
enable_one_d_blur_scanner If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_itf_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_itf_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_itf_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_itf_configuration_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_barcode_format_itf_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_itf_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_free | ( | scanbotsdk_barcode_format_itf_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_itf_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_itf_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_itf_configuration_get_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_get_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_itf_configuration_t * | self, |
| bool * | enable_one_d_blur_scanner ) |
Returns value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_itf_configuration_t enable_one_d_blur_scanner Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_itf_configuration_get_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_get_maximum_text_length | ( | scanbotsdk_barcode_format_itf_configuration_t * | self, |
| int * | maximum_text_length ) |
Returns value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_itf_configuration_t maximum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_itf_configuration_get_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_get_minimum_text_length | ( | scanbotsdk_barcode_format_itf_configuration_t * | self, |
| int * | minimum_text_length ) |
Returns value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_itf_configuration_t minimum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_itf_configuration_set_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_set_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_itf_configuration_t * | self, |
| bool | enable_one_d_blur_scanner ) |
Sets value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
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_barcode_format_itf_configuration_t, the field of which will be set enable_one_d_blur_scanner The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_itf_configuration_set_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_set_maximum_text_length | ( | scanbotsdk_barcode_format_itf_configuration_t * | self, |
| int | maximum_text_length ) |
Sets value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
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_barcode_format_itf_configuration_t, the field of which will be set maximum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_itf_configuration_set_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_itf_configuration_set_minimum_text_length | ( | scanbotsdk_barcode_format_itf_configuration_t * | self, |
| int | minimum_text_length ) |
Sets value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
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_barcode_format_itf_configuration_t, the field of which will be set minimum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_japan_post_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_japan_post_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_japan_post_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_japan_post_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_japan_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_japan_post_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_japan_post_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base | ( | scanbotsdk_barcode_format_japan_post_configuration_t * | object, |
| scanbotsdk_barcode_format_four_state_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_japan_post_configuration_t to its parent type scanbotsdk_barcode_format_four_state_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_japan_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_japan_post_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_japan_post_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_barcode_format_japan_post_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_japan_post_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_japan_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_japan_post_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_japan_post_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_japan_post_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_japan_post_configuration_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_barcode_format_japan_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_japan_post_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_japan_post_configuration_free | ( | scanbotsdk_barcode_format_japan_post_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_japan_post_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_japan_post_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_maxi_code_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_maxi_code_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_maxi_code_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_maxi_code_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_maxi_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_maxi_code_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_maxi_code_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base | ( | scanbotsdk_barcode_format_maxi_code_configuration_t * | object, |
| scanbotsdk_barcode_format_two_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_maxi_code_configuration_t to its parent type scanbotsdk_barcode_format_two_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_maxi_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_maxi_code_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_maxi_code_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_barcode_format_maxi_code_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_maxi_code_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_maxi_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_maxi_code_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_maxi_code_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_maxi_code_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_maxi_code_configuration_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_barcode_format_maxi_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_maxi_code_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_maxi_code_configuration_free | ( | scanbotsdk_barcode_format_maxi_code_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_maxi_code_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_maxi_code_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_micro_pdf_417_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_micro_pdf_417_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_micro_pdf_417_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_micro_pdf_417_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_micro_pdf_417_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base | ( | scanbotsdk_barcode_format_micro_pdf_417_configuration_t * | object, |
| scanbotsdk_barcode_format_two_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t to its parent type scanbotsdk_barcode_format_two_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_micro_pdf_417_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_micro_pdf_417_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| bool | strict_mode, | ||
| scanbotsdk_barcode_format_micro_pdf_417_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_micro_pdf_417_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
strict_mode If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_micro_pdf_417_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_micro_pdf_417_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_micro_pdf_417_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_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_barcode_format_micro_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_micro_pdf_417_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_micro_pdf_417_configuration_free | ( | scanbotsdk_barcode_format_micro_pdf_417_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_micro_pdf_417_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_micro_pdf_417_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_micro_pdf_417_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_micro_pdf_417_configuration_get_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_micro_pdf_417_configuration_get_strict_mode | ( | scanbotsdk_barcode_format_micro_pdf_417_configuration_t * | self, |
| bool * | strict_mode ) |
Returns value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t strict_mode Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_micro_pdf_417_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_micro_pdf_417_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_micro_pdf_417_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_micro_pdf_417_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_micro_pdf_417_configuration_set_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_micro_pdf_417_configuration_set_strict_mode | ( | scanbotsdk_barcode_format_micro_pdf_417_configuration_t * | self, |
| bool | strict_mode ) |
Sets value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
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_barcode_format_micro_pdf_417_configuration_t, the field of which will be set strict_mode The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_msi_plessey_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_msi_plessey_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_msi_plessey_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_msi_plessey_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_msi_plessey_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_msi_plessey_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_msi_plessey_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| bool | strip_check_digits, | ||
| int | minimum_text_length, | ||
| int | maximum_text_length, | ||
| bool | enable_one_d_blur_scanner, | ||
| scanbotsdk_msi_plessey_checksum_algorithm_t * | checksum_algorithms, | ||
| size_t | checksum_algorithms_size, | ||
| scanbotsdk_barcode_format_msi_plessey_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_msi_plessey_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
strip_check_digits If true, the check digits are stripped from the result.
Default is false
- Parameters
-
minimum_text_length Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
maximum_text_length Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
enable_one_d_blur_scanner If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
checksum_algorithms List of MSI Plessey checksum algorithms to apply during scanning. A barcode is considered valid if it passes any of the checksum algorithms in the list. If the list is empty, no checksum validation is performed. checksum_algorithms_size Size of the array checksum_algorithms result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_msi_plessey_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_msi_plessey_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_msi_plessey_configuration_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_barcode_format_msi_plessey_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_msi_plessey_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_free | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_msi_plessey_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_msi_plessey_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_msi_plessey_configuration_get_checksum_algorithms()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_get_checksum_algorithms | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| scanbotsdk_msi_plessey_checksum_algorithm_t ** | checksum_algorithms ) |
Returns value of checksum_algorithms field of the given object. The returned value is direct view into memory, no pre-allocations needed.
List of MSI Plessey checksum algorithms to apply during scanning. A barcode is considered valid if it passes any of the checksum algorithms in the list. If the list is empty, no checksum validation is performed.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_msi_plessey_configuration_t checksum_algorithms Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_msi_plessey_configuration_get_checksum_algorithms_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_get_checksum_algorithms_size | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| size_t * | size ) |
Returns size of checksum_algorithms array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_msi_plessey_configuration_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_msi_plessey_configuration_get_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_get_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| bool * | enable_one_d_blur_scanner ) |
Returns value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_msi_plessey_configuration_t enable_one_d_blur_scanner Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_msi_plessey_configuration_get_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_get_maximum_text_length | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| int * | maximum_text_length ) |
Returns value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_msi_plessey_configuration_t maximum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_msi_plessey_configuration_get_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_get_minimum_text_length | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| int * | minimum_text_length ) |
Returns value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_msi_plessey_configuration_t minimum_text_length Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_msi_plessey_configuration_get_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_get_strip_check_digits | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| bool * | strip_check_digits ) |
Returns value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_msi_plessey_configuration_t strip_check_digits Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_msi_plessey_configuration_set_checksum_algorithms()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_set_checksum_algorithms | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| scanbotsdk_msi_plessey_checksum_algorithm_t * | checksum_algorithms, | ||
| size_t | checksum_algorithms_size ) |
Sets value of checksum_algorithms field of the given object.
List of MSI Plessey checksum algorithms to apply during scanning. A barcode is considered valid if it passes any of the checksum algorithms in the list. If the list is empty, no checksum validation is performed.
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_barcode_format_msi_plessey_configuration_t, the field of which will be set checksum_algorithms The value to be set. checksum_algorithms_size Size of the array.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_msi_plessey_configuration_set_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_set_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| bool | enable_one_d_blur_scanner ) |
Sets value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
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_barcode_format_msi_plessey_configuration_t, the field of which will be set enable_one_d_blur_scanner The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_msi_plessey_configuration_set_maximum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_set_maximum_text_length | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| int | maximum_text_length ) |
Sets value of maximum_text_length field of the given object.
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
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_barcode_format_msi_plessey_configuration_t, the field of which will be set maximum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_msi_plessey_configuration_set_minimum_text_length()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_set_minimum_text_length | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| int | minimum_text_length ) |
Sets value of minimum_text_length field of the given object.
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
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_barcode_format_msi_plessey_configuration_t, the field of which will be set minimum_text_length The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_msi_plessey_configuration_set_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_msi_plessey_configuration_set_strip_check_digits | ( | scanbotsdk_barcode_format_msi_plessey_configuration_t * | self, |
| bool | strip_check_digits ) |
Sets value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
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_barcode_format_msi_plessey_configuration_t, the field of which will be set strip_check_digits The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_codabar_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_codabar_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_codabar_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_codabar_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_codabar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_code_11_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_code_11_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_code_11_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_code_11_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_11_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_code_128_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_code_128_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_code_128_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_code_128_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_128_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_code_2_of_5_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_code_2_of_5_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_code_2_of_5_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_code_2_of_5_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_2_of_5_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_code_39_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_code_39_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_code_39_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_code_39_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_39_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_code_93_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_code_93_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_code_93_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_code_93_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_code_93_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_one_d_configuration_base_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_data_bar_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_data_bar_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_data_bar_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_data_bar_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_data_bar_expanded_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_data_bar_expanded_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_data_bar_expanded_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_data_bar_expanded_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_expanded_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_data_bar_limited_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_data_bar_limited_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_data_bar_limited_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_data_bar_limited_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_bar_limited_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_itf_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_itf_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_itf_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_itf_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_itf_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_msi_plessey_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_msi_plessey_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_msi_plessey_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_msi_plessey_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_msi_plessey_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_pharma_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_pharma_code_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_pharma_code_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_pharma_code_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pharma_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_upc_ean_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_as_scanbotsdk_barcode_format_upc_ean_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_upc_ean_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t to its subtype scanbotsdk_barcode_format_upc_ean_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_upc_ean_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_free | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_one_d_configuration_base_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_get_minimum_1_d_confirmation_count()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_get_minimum_1_d_confirmation_count | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | self, |
| int * | minimum_1_d_confirmation_count ) |
Returns value of minimum_1_d_confirmation_count field of the given object.
In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t minimum_1_d_confirmation_count Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_one_d_configuration_base_get_minimum_1_d_quiet_zone_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_get_minimum_1_d_quiet_zone_size | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | self, |
| int * | minimum_1_d_quiet_zone_size ) |
Returns value of minimum_1_d_quiet_zone_size field of the given object.
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t minimum_1_d_quiet_zone_size Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_codabar_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_codabar_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_codabar_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_code_11_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_code_11_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_code_11_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_code_128_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_code_128_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_code_128_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_code_2_of_5_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_code_2_of_5_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_code_2_of_5_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_code_39_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_code_39_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_code_39_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_code_93_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_code_93_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_code_93_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_data_bar_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_data_bar_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_data_bar_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_data_bar_expanded_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_data_bar_expanded_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_data_bar_expanded_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_data_bar_limited_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_data_bar_limited_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_data_bar_limited_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_itf_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_itf_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_itf_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_msi_plessey_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_msi_plessey_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_msi_plessey_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_pharma_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_pharma_code_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_pharma_code_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_upc_ean_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_is_scanbotsdk_barcode_format_upc_ean_configuration | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_one_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_upc_ean_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_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_barcode_format_one_d_configuration_base_set_minimum_1_d_confirmation_count()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_set_minimum_1_d_confirmation_count | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | self, |
| int | minimum_1_d_confirmation_count ) |
Sets value of minimum_1_d_confirmation_count field of the given object.
In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
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_barcode_format_one_d_configuration_base_t, the field of which will be set minimum_1_d_confirmation_count The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_one_d_configuration_base_set_minimum_1_d_quiet_zone_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_one_d_configuration_base_set_minimum_1_d_quiet_zone_size | ( | scanbotsdk_barcode_format_one_d_configuration_base_t * | self, |
| int | minimum_1_d_quiet_zone_size ) |
Sets value of minimum_1_d_quiet_zone_size field of the given object.
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
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_barcode_format_one_d_configuration_base_t, the field of which will be set minimum_1_d_quiet_zone_size The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pdf_417_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pdf_417_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_pdf_417_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_pdf_417_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pdf_417_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pdf_417_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base | ( | scanbotsdk_barcode_format_pdf_417_configuration_t * | object, |
| scanbotsdk_barcode_format_two_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_pdf_417_configuration_t to its parent type scanbotsdk_barcode_format_two_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pdf_417_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pdf_417_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| bool | strict_mode, | ||
| scanbotsdk_barcode_format_pdf_417_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_pdf_417_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
strict_mode If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pdf_417_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pdf_417_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_pdf_417_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_pdf_417_configuration_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_barcode_format_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pdf_417_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pdf_417_configuration_free | ( | scanbotsdk_barcode_format_pdf_417_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_pdf_417_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_pdf_417_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pdf_417_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pdf_417_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_pdf_417_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_pdf_417_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_pdf_417_configuration_get_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pdf_417_configuration_get_strict_mode | ( | scanbotsdk_barcode_format_pdf_417_configuration_t * | self, |
| bool * | strict_mode ) |
Returns value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_pdf_417_configuration_t strict_mode Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_pdf_417_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pdf_417_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_pdf_417_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_pdf_417_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pdf_417_configuration_set_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pdf_417_configuration_set_strict_mode | ( | scanbotsdk_barcode_format_pdf_417_configuration_t * | self, |
| bool | strict_mode ) |
Sets value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
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_barcode_format_pdf_417_configuration_t, the field of which will be set strict_mode The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_pharma_code_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_pharma_code_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pharma_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_pharma_code_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_pharma_code_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pharma_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| int | minimum_value, | ||
| bool | allow_narrow_bars_only, | ||
| bool | allow_wide_bars_only, | ||
| scanbotsdk_barcode_format_pharma_code_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_pharma_code_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
minimum_value Minimum value for PharmaCode. Very low values are likely to produce more false positives.
Default is 16
- Parameters
-
allow_narrow_bars_only If true, a result consisting of only narrow bars is accepted as valid. The specification does not recommend such barcodes. Default is false.
Default is false
- Parameters
-
allow_wide_bars_only If true, a result consisting of only wide bars is accepted as valid. The specification does not recommend such barcodes. Default is false.
Default is false
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_pharma_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_pharma_code_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_pharma_code_configuration_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_barcode_format_pharma_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_free | ( | scanbotsdk_barcode_format_pharma_code_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_pharma_code_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_pharma_code_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_configuration_get_allow_narrow_bars_only()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_get_allow_narrow_bars_only | ( | scanbotsdk_barcode_format_pharma_code_configuration_t * | self, |
| bool * | allow_narrow_bars_only ) |
Returns value of allow_narrow_bars_only field of the given object.
If true, a result consisting of only narrow bars is accepted as valid. The specification does not recommend such barcodes. Default is false.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_pharma_code_configuration_t allow_narrow_bars_only Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_pharma_code_configuration_get_allow_wide_bars_only()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_get_allow_wide_bars_only | ( | scanbotsdk_barcode_format_pharma_code_configuration_t * | self, |
| bool * | allow_wide_bars_only ) |
Returns value of allow_wide_bars_only field of the given object.
If true, a result consisting of only wide bars is accepted as valid. The specification does not recommend such barcodes. Default is false.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_pharma_code_configuration_t allow_wide_bars_only Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_pharma_code_configuration_get_minimum_value()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_get_minimum_value | ( | scanbotsdk_barcode_format_pharma_code_configuration_t * | self, |
| int * | minimum_value ) |
Returns value of minimum_value field of the given object.
Minimum value for PharmaCode. Very low values are likely to produce more false positives.
Default is 16
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_pharma_code_configuration_t minimum_value Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_pharma_code_configuration_set_allow_narrow_bars_only()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_set_allow_narrow_bars_only | ( | scanbotsdk_barcode_format_pharma_code_configuration_t * | self, |
| bool | allow_narrow_bars_only ) |
Sets value of allow_narrow_bars_only field of the given object.
If true, a result consisting of only narrow bars is accepted as valid. The specification does not recommend such barcodes. Default is false.
Default is false
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_barcode_format_pharma_code_configuration_t, the field of which will be set allow_narrow_bars_only The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_configuration_set_allow_wide_bars_only()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_set_allow_wide_bars_only | ( | scanbotsdk_barcode_format_pharma_code_configuration_t * | self, |
| bool | allow_wide_bars_only ) |
Sets value of allow_wide_bars_only field of the given object.
If true, a result consisting of only wide bars is accepted as valid. The specification does not recommend such barcodes. Default is false.
Default is false
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_barcode_format_pharma_code_configuration_t, the field of which will be set allow_wide_bars_only The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_configuration_set_minimum_value()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_configuration_set_minimum_value | ( | scanbotsdk_barcode_format_pharma_code_configuration_t * | self, |
| int | minimum_value ) |
Sets value of minimum_value field of the given object.
Minimum value for PharmaCode. Very low values are likely to produce more false positives.
Default is 16
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_barcode_format_pharma_code_configuration_t, the field of which will be set minimum_value The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_two_track_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_two_track_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_pharma_code_two_track_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_two_track_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_two_track_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base | ( | scanbotsdk_barcode_format_pharma_code_two_track_configuration_t * | object, |
| scanbotsdk_barcode_format_four_state_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_t to its parent type scanbotsdk_barcode_format_four_state_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_two_track_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_two_track_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_value, | ||
| scanbotsdk_barcode_format_pharma_code_two_track_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_value Minimum value for PHARMA_CODE_TWO_TRACK. Very low values are likely to produce more false positives.
Default is 364
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_two_track_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_two_track_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_pharma_code_two_track_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_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_barcode_format_pharma_code_two_track_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_two_track_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_two_track_configuration_free | ( | scanbotsdk_barcode_format_pharma_code_two_track_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_pharma_code_two_track_configuration_get_minimum_value()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_two_track_configuration_get_minimum_value | ( | scanbotsdk_barcode_format_pharma_code_two_track_configuration_t * | self, |
| int * | minimum_value ) |
Returns value of minimum_value field of the given object.
Minimum value for PHARMA_CODE_TWO_TRACK. Very low values are likely to produce more false positives.
Default is 364
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_pharma_code_two_track_configuration_t minimum_value Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_pharma_code_two_track_configuration_set_minimum_value()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_pharma_code_two_track_configuration_set_minimum_value | ( | scanbotsdk_barcode_format_pharma_code_two_track_configuration_t * | self, |
| int | minimum_value ) |
Sets value of minimum_value field of the given object.
Minimum value for PHARMA_CODE_TWO_TRACK. Very low values are likely to produce more false positives.
Default is 364
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_barcode_format_pharma_code_two_track_configuration_t, the field of which will be set minimum_value The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_qr_code_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_qr_code_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_qr_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_qr_code_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_as_scanbotsdk_barcode_format_two_d_configuration_base | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | object, |
| scanbotsdk_barcode_format_two_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_qr_code_configuration_t to its parent type scanbotsdk_barcode_format_two_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_qr_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_qr_code_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_gs_1_handling_t | gs_1_handling, | ||
| bool | strict_mode, | ||
| bool | qr, | ||
| bool | micro_qr, | ||
| bool | rmqr, | ||
| scanbotsdk_barcode_format_qr_code_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_qr_code_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
gs_1_handling GS1 message handling options.
Default is PARSE
- Parameters
-
strict_mode If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
qr If true, scan and return QR codes.
Default is true
- Parameters
-
micro_qr If true, scan and return Micro QR codes.
Default is false
- Parameters
-
rmqr If true, scan and return rectangular Micro QR (rMQR) codes.
Default is false
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_qr_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_qr_code_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_qr_code_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_qr_code_configuration_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_barcode_format_qr_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_qr_code_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_free | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_qr_code_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_qr_code_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_qr_code_configuration_get_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_get_gs_1_handling | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t * | gs_1_handling ) |
Returns value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_qr_code_configuration_t gs_1_handling Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_qr_code_configuration_get_micro_qr()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_get_micro_qr | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | self, |
| bool * | micro_qr ) |
Returns value of micro_qr field of the given object.
If true, scan and return Micro QR codes.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_qr_code_configuration_t micro_qr Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_qr_code_configuration_get_qr()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_get_qr | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | self, |
| bool * | qr ) |
Returns value of qr field of the given object.
If true, scan and return QR codes.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_qr_code_configuration_t qr Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_qr_code_configuration_get_rmqr()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_get_rmqr | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | self, |
| bool * | rmqr ) |
Returns value of rmqr field of the given object.
If true, scan and return rectangular Micro QR (rMQR) codes.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_qr_code_configuration_t rmqr Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_qr_code_configuration_get_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_get_strict_mode | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | self, |
| bool * | strict_mode ) |
Returns value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_qr_code_configuration_t strict_mode Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_qr_code_configuration_set_gs_1_handling()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_set_gs_1_handling | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | self, |
| scanbotsdk_gs_1_handling_t | gs_1_handling ) |
Sets value of gs_1_handling field of the given object.
GS1 message handling options.
Default is PARSE
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_barcode_format_qr_code_configuration_t, the field of which will be set gs_1_handling The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_qr_code_configuration_set_micro_qr()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_set_micro_qr | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | self, |
| bool | micro_qr ) |
Sets value of micro_qr field of the given object.
If true, scan and return Micro QR codes.
Default is false
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_barcode_format_qr_code_configuration_t, the field of which will be set micro_qr The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_qr_code_configuration_set_qr()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_set_qr | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | self, |
| bool | qr ) |
Sets value of qr field of the given object.
If true, scan and return QR codes.
Default is true
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_barcode_format_qr_code_configuration_t, the field of which will be set qr The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_qr_code_configuration_set_rmqr()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_set_rmqr | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | self, |
| bool | rmqr ) |
Sets value of rmqr field of the given object.
If true, scan and return rectangular Micro QR (rMQR) codes.
Default is false
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_barcode_format_qr_code_configuration_t, the field of which will be set rmqr The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_qr_code_configuration_set_strict_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_qr_code_configuration_set_strict_mode | ( | scanbotsdk_barcode_format_qr_code_configuration_t * | self, |
| bool | strict_mode ) |
Sets value of strict_mode field of the given object.
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.
Default is true
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_barcode_format_qr_code_configuration_t, the field of which will be set strict_mode The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_mail_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_mail_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_royal_mail_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_royal_mail_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_royal_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_mail_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_mail_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base | ( | scanbotsdk_barcode_format_royal_mail_configuration_t * | object, |
| scanbotsdk_barcode_format_four_state_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_royal_mail_configuration_t to its parent type scanbotsdk_barcode_format_four_state_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_royal_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_mail_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_mail_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| bool | strip_check_digits, | ||
| scanbotsdk_barcode_format_royal_mail_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_royal_mail_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
strip_check_digits If true, the check digits are stripped from the result.
Default is false
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_royal_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_mail_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_mail_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_royal_mail_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_royal_mail_configuration_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_barcode_format_royal_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_mail_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_mail_configuration_free | ( | scanbotsdk_barcode_format_royal_mail_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_royal_mail_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_royal_mail_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_mail_configuration_get_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_mail_configuration_get_strip_check_digits | ( | scanbotsdk_barcode_format_royal_mail_configuration_t * | self, |
| bool * | strip_check_digits ) |
Returns value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_royal_mail_configuration_t strip_check_digits Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_royal_mail_configuration_set_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_mail_configuration_set_strip_check_digits | ( | scanbotsdk_barcode_format_royal_mail_configuration_t * | self, |
| bool | strip_check_digits ) |
Sets value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
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_barcode_format_royal_mail_configuration_t, the field of which will be set strip_check_digits The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_tnt_post_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_tnt_post_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_royal_tnt_post_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_royal_tnt_post_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_royal_tnt_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_tnt_post_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_tnt_post_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base | ( | scanbotsdk_barcode_format_royal_tnt_post_configuration_t * | object, |
| scanbotsdk_barcode_format_four_state_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_royal_tnt_post_configuration_t to its parent type scanbotsdk_barcode_format_four_state_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_royal_tnt_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_tnt_post_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_tnt_post_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_barcode_format_royal_tnt_post_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_royal_tnt_post_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_royal_tnt_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_tnt_post_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_tnt_post_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_royal_tnt_post_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_royal_tnt_post_configuration_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_barcode_format_royal_tnt_post_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_royal_tnt_post_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_royal_tnt_post_configuration_free | ( | scanbotsdk_barcode_format_royal_tnt_post_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_royal_tnt_post_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_royal_tnt_post_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_t_to_string | ( | scanbotsdk_barcode_format_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_barcode_format_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_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_aztec_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_aztec_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_aztec_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t to its subtype scanbotsdk_barcode_format_aztec_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_aztec_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_two_d_configuration_base_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_data_matrix_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_data_matrix_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_data_matrix_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t to its subtype scanbotsdk_barcode_format_data_matrix_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_data_matrix_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_maxi_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_maxi_code_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_maxi_code_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t to its subtype scanbotsdk_barcode_format_maxi_code_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_maxi_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_micro_pdf_417_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_micro_pdf_417_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_micro_pdf_417_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t to its subtype scanbotsdk_barcode_format_micro_pdf_417_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_micro_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_pdf_417_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_pdf_417_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_pdf_417_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t to its subtype scanbotsdk_barcode_format_pdf_417_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_pdf_417_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_qr_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_as_scanbotsdk_barcode_format_qr_code_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| scanbotsdk_barcode_format_qr_code_configuration_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t to its subtype scanbotsdk_barcode_format_qr_code_configuration_t. If the given instance is not an instance of the subtype, result will be null.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_qr_code_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_two_d_configuration_base_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_free | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_two_d_configuration_base_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_aztec_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_aztec_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_aztec_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_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_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_data_matrix_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_data_matrix_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_data_matrix_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_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_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_maxi_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_maxi_code_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_maxi_code_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_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_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_micro_pdf_417_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_micro_pdf_417_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_micro_pdf_417_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_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_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_pdf_417_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_pdf_417_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_pdf_417_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_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_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_qr_code_configuration()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_two_d_configuration_base_is_scanbotsdk_barcode_format_qr_code_configuration | ( | scanbotsdk_barcode_format_two_d_configuration_base_t * | object, |
| bool * | result ) |
Checks if the given instance of scanbotsdk_barcode_format_two_d_configuration_base_t is an instance of its subtype scanbotsdk_barcode_format_qr_code_configuration_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_two_d_configuration_base_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_barcode_format_upc_ean_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_upc_ean_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_upc_ean_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_as_scanbotsdk_barcode_format_one_d_configuration_base | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | object, |
| scanbotsdk_barcode_format_one_d_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_upc_ean_configuration_t to its parent type scanbotsdk_barcode_format_one_d_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_one_d_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_upc_ean_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| int | minimum_1_d_quiet_zone_size, | ||
| int | minimum_1_d_confirmation_count, | ||
| bool | strip_check_digits, | ||
| bool | enable_one_d_blur_scanner, | ||
| bool | ean_8, | ||
| bool | ean_13, | ||
| bool | upca, | ||
| bool | upce, | ||
| scanbotsdk_upc_ean_extension_behavior_t | extensions, | ||
| int | minimum_standalone_confirmation_count, | ||
| scanbotsdk_barcode_format_upc_ean_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_upc_ean_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
minimum_1_d_quiet_zone_size Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.
Default is 6
- Parameters
-
minimum_1_d_confirmation_count In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid.
Default is 1
- Parameters
-
strip_check_digits If true, the check digits are stripped from the result.
Default is false
- Parameters
-
enable_one_d_blur_scanner If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
ean_8 If true, scan and return valid EAN-8 barcodes.
Default is true
- Parameters
-
ean_13 If true, scan and return valid EAN-13 barcodes.
Default is true
- Parameters
-
upca If true, scan and return valid UPC-A barcodes. If false, but ean13 is true, then UPC-A barcodes will be returned as EAN-13 barcodes.
Default is true
- Parameters
-
upce If true, scan and return valid UPC-E barcodes.
Default is true
- Parameters
-
extensions Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
Default is ALLOW_ANY
- Parameters
-
minimum_standalone_confirmation_count In case that ean/upc both with and without extensions are allowed, we require confirmations to consider a standalone EAN or UPC (i.e. without extension) as valid.
Default is 1
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_upc_ean_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_upc_ean_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_upc_ean_configuration_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_barcode_format_upc_ean_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_free | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_upc_ean_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_upc_ean_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_get_ean_13()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_get_ean_13 | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool * | ean_13 ) |
Returns value of ean_13 field of the given object.
If true, scan and return valid EAN-13 barcodes.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_upc_ean_configuration_t ean_13 Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_upc_ean_configuration_get_ean_8()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_get_ean_8 | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool * | ean_8 ) |
Returns value of ean_8 field of the given object.
If true, scan and return valid EAN-8 barcodes.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_upc_ean_configuration_t ean_8 Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_upc_ean_configuration_get_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_get_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool * | enable_one_d_blur_scanner ) |
Returns value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_upc_ean_configuration_t enable_one_d_blur_scanner Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_upc_ean_configuration_get_extensions()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_get_extensions | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| scanbotsdk_upc_ean_extension_behavior_t * | extensions ) |
Returns value of extensions field of the given object.
Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
Default is ALLOW_ANY
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_upc_ean_configuration_t extensions Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_upc_ean_configuration_get_minimum_standalone_confirmation_count()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_get_minimum_standalone_confirmation_count | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| int * | minimum_standalone_confirmation_count ) |
Returns value of minimum_standalone_confirmation_count field of the given object.
In case that ean/upc both with and without extensions are allowed, we require confirmations to consider a standalone EAN or UPC (i.e. without extension) as valid.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_upc_ean_configuration_t minimum_standalone_confirmation_count Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_upc_ean_configuration_get_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_get_strip_check_digits | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool * | strip_check_digits ) |
Returns value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_upc_ean_configuration_t strip_check_digits Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_upc_ean_configuration_get_upca()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_get_upca | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool * | upca ) |
Returns value of upca field of the given object.
If true, scan and return valid UPC-A barcodes. If false, but ean13 is true, then UPC-A barcodes will be returned as EAN-13 barcodes.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_upc_ean_configuration_t upca Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_upc_ean_configuration_get_upce()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_get_upce | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool * | upce ) |
Returns value of upce field of the given object.
If true, scan and return valid UPC-E barcodes.
Default is true
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_format_upc_ean_configuration_t upce Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_format_upc_ean_configuration_set_ean_13()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_set_ean_13 | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool | ean_13 ) |
Sets value of ean_13 field of the given object.
If true, scan and return valid EAN-13 barcodes.
Default is true
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_barcode_format_upc_ean_configuration_t, the field of which will be set ean_13 The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_set_ean_8()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_set_ean_8 | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool | ean_8 ) |
Sets value of ean_8 field of the given object.
If true, scan and return valid EAN-8 barcodes.
Default is true
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_barcode_format_upc_ean_configuration_t, the field of which will be set ean_8 The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_set_enable_one_d_blur_scanner()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_set_enable_one_d_blur_scanner | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool | enable_one_d_blur_scanner ) |
Sets value of enable_one_d_blur_scanner field of the given object.
If true, barcodes with heavy blur or from far distance are tried to scan.
Default is true
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_barcode_format_upc_ean_configuration_t, the field of which will be set enable_one_d_blur_scanner The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_set_extensions()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_set_extensions | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| scanbotsdk_upc_ean_extension_behavior_t | extensions ) |
Sets value of extensions field of the given object.
Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
Default is ALLOW_ANY
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_barcode_format_upc_ean_configuration_t, the field of which will be set extensions The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_set_minimum_standalone_confirmation_count()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_set_minimum_standalone_confirmation_count | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| int | minimum_standalone_confirmation_count ) |
Sets value of minimum_standalone_confirmation_count field of the given object.
In case that ean/upc both with and without extensions are allowed, we require confirmations to consider a standalone EAN or UPC (i.e. without extension) as valid.
Default is 1
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_barcode_format_upc_ean_configuration_t, the field of which will be set minimum_standalone_confirmation_count The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_set_strip_check_digits()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_set_strip_check_digits | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool | strip_check_digits ) |
Sets value of strip_check_digits field of the given object.
If true, the check digits are stripped from the result.
Default is false
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_barcode_format_upc_ean_configuration_t, the field of which will be set strip_check_digits The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_set_upca()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_set_upca | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool | upca ) |
Sets value of upca field of the given object.
If true, scan and return valid UPC-A barcodes. If false, but ean13 is true, then UPC-A barcodes will be returned as EAN-13 barcodes.
Default is true
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_barcode_format_upc_ean_configuration_t, the field of which will be set upca The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_upc_ean_configuration_set_upce()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_upc_ean_configuration_set_upce | ( | scanbotsdk_barcode_format_upc_ean_configuration_t * | self, |
| bool | upce ) |
Sets value of upce field of the given object.
If true, scan and return valid UPC-E barcodes.
Default is true
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_barcode_format_upc_ean_configuration_t, the field of which will be set upce The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_usps_intelligent_mail_configuration_as_scanbotsdk_barcode_format_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_usps_intelligent_mail_configuration_as_scanbotsdk_barcode_format_configuration_base | ( | scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t * | object, |
| scanbotsdk_barcode_format_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t to its parent type scanbotsdk_barcode_format_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_usps_intelligent_mail_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_usps_intelligent_mail_configuration_as_scanbotsdk_barcode_format_four_state_configuration_base | ( | scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t * | object, |
| scanbotsdk_barcode_format_four_state_configuration_base_t ** | result ) |
Casts the given instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t to its parent type scanbotsdk_barcode_format_four_state_configuration_base_t.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_four_state_configuration_base_t to be casted result Pointer to a variable that will store the casted instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_usps_intelligent_mail_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_usps_intelligent_mail_configuration_create | ( | const char * | regex_filter, |
| double | minimum_size_score, | ||
| bool | add_additional_quiet_zone, | ||
| scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration 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
-
regex_filter Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).
Default is "" The value must not be null.
- Parameters
-
minimum_size_score Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.
Default is 0
- Parameters
-
add_additional_quiet_zone If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.
Default is false
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_usps_intelligent_mail_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_usps_intelligent_mail_configuration_create_with_defaults | ( | scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration_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_barcode_format_usps_intelligent_mail_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_format_usps_intelligent_mail_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_format_usps_intelligent_mail_configuration_free | ( | scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_format_usps_intelligent_mail_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_item_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_free | ( | scanbotsdk_barcode_item_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_item_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_item_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_item_get_data_bar_stack_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_data_bar_stack_size | ( | scanbotsdk_barcode_item_t * | self, |
| int * | data_bar_stack_size ) |
Returns value of data_bar_stack_size field of the given object.
The number of 1D stacks in the barcode. Applies only to DATABAR and DATABAR_EXPANDED barcodes.
Default is 1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t data_bar_stack_size Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_extended_quad()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extended_quad | ( | scanbotsdk_barcode_item_t * | self, |
| scanbotsdk_point_t ** | extended_quad ) |
Returns value of extended_quad field of the given object. The returned value is direct view into memory, no pre-allocations needed.
As quad, but extended to appropriate height for oned barcodes.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t extended_quad Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_extended_quad_normalized()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extended_quad_normalized | ( | scanbotsdk_barcode_item_t * | self, |
| scanbotsdk_pointf_t ** | extended_quad_normalized ) |
Returns value of extended_quad_normalized field of the given object. The returned value is direct view into memory, no pre-allocations needed.
As quadNormalized, but extended to appropriate height for oned barcodes.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t extended_quad_normalized Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_extended_quad_normalized_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extended_quad_normalized_size | ( | scanbotsdk_barcode_item_t * | self, |
| size_t * | size ) |
Returns size of extended_quad_normalized array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_extended_quad_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extended_quad_size | ( | scanbotsdk_barcode_item_t * | self, |
| size_t * | size ) |
Returns size of extended_quad array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_extracted_document()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extracted_document | ( | scanbotsdk_barcode_item_t * | self, |
| scanbotsdk_generic_document_t ** | extracted_document ) |
Returns value of extracted_document field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
The parsed known document format (if parsed successfully).
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t extracted_document Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_format()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_format | ( | scanbotsdk_barcode_item_t * | self, |
| scanbotsdk_barcode_format_t * | format ) |
Returns value of format field of the given object.
Barcode format.
Default is NONE
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t format Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_global_index()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_global_index | ( | scanbotsdk_barcode_item_t * | self, |
| int * | global_index ) |
Returns value of global_index field of the given object.
The index of the barcode to uniquely identify it. In case of frame accumulation, the index remains the same across frames.
Default is -1
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t global_index Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_is_gs_1_composite_part()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_is_gs_1_composite_part | ( | scanbotsdk_barcode_item_t * | self, |
| bool * | is_gs_1_composite_part ) |
Returns value of is_gs_1_composite_part field of the given object.
True if this result is the 2D part of a GS1 Composite barcode. Can only happen if GS1_COMPOSITE scanning is disabled and a part of the composite (1D) or (2D) is scanned separately. When GS1_COMPOSITE scanning is enabled, parts of the composite barcode are never returned separately, even if their respective format is enabled in the decoding options.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t is_gs_1_composite_part Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_is_gs_1_message()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_is_gs_1_message | ( | scanbotsdk_barcode_item_t * | self, |
| bool * | is_gs_1_message ) |
Returns value of is_gs_1_message field of the given object.
True if the barcode contains a GS1 message. Requires GS1 handling to be enabled in the decoding option.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t is_gs_1_message Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_is_upside_down()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_is_upside_down | ( | scanbotsdk_barcode_item_t * | self, |
| bool * | is_upside_down ) |
Returns value of is_upside_down field of the given object.
True if this is a 1D barcode that is printed upside-down, that is, the barcode was scanned right-to-left.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t is_upside_down Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_quad()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_quad | ( | scanbotsdk_barcode_item_t * | self, |
| scanbotsdk_point_t ** | quad ) |
Returns value of quad field of the given object. The returned value is direct view into memory, no pre-allocations needed.
The four corners of the barcode in the input image, in clockwise order starting from the top left, in image coordinates.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t quad Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_quad_normalized()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_quad_normalized | ( | scanbotsdk_barcode_item_t * | self, |
| scanbotsdk_pointf_t ** | quad_normalized ) |
Returns value of quad_normalized field of the given object. The returned value is direct view into memory, no pre-allocations needed.
The four corners of the barcode in the input image, in clockwise order starting from the top left, normalized to the range [0, 1].
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t quad_normalized Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_quad_normalized_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_quad_normalized_size | ( | scanbotsdk_barcode_item_t * | self, |
| size_t * | size ) |
Returns size of quad_normalized array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_quad_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_quad_size | ( | scanbotsdk_barcode_item_t * | self, |
| size_t * | size ) |
Returns size of quad array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_raw_bytes()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_raw_bytes | ( | scanbotsdk_barcode_item_t * | self, |
| uint8_t ** | raw_bytes ) |
Returns value of raw_bytes field of the given object. The returned value is direct view into memory, no pre-allocations needed.
Raw bytes of barcode contents. Some barcode formats are able to encode binary data. If a barcode contains binary data, it's provided as a list of bytes in the rawBytes field. Some barcode formats additionally allow pieces of the data within to have different encodings - UTF-8, ASCII, binary, etc. The rawBytesEncodings field lists the encoding of each range in the rawBytes array. For barcode formats that contain a GS1 message (e.g. GS1 Composite), we recommend to use a GS1Handling and extract the GS1 message from the text.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t raw_bytes Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_raw_bytes_encodings()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_raw_bytes_encodings | ( | scanbotsdk_barcode_item_t * | self, |
| scanbotsdk_range_encoding_t ** | raw_bytes_encodings, | ||
| size_t | size ) |
Returns value of raw_bytes_encodings field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Encoding information for the rawBytes field. Each element of this list covers some portion of the rawBytes array. Taken together, the elements of the list cover the entirety of the rawBytes array without overlap and without holes. The elements are ordered in increasing order of the start and end indices.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t size Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function. raw_bytes_encodings Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_raw_bytes_encodings_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_raw_bytes_encodings_size | ( | scanbotsdk_barcode_item_t * | self, |
| size_t * | size ) |
Returns size of raw_bytes_encodings array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_raw_bytes_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_raw_bytes_size | ( | scanbotsdk_barcode_item_t * | self, |
| size_t * | size ) |
Returns size of raw_bytes array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_size_score()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_size_score | ( | scanbotsdk_barcode_item_t * | self, |
| double * | size_score ) |
Returns value of size_score field of the given object.
The size score is a floating point value between 0 and 1 that represents the relative size of the barcode in the input image. Barcodes taking up a small portion of the input image will have a score close to 0, while barcodes that take a large portion will have a score close to 1.
Default is 0
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t size_score Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_source_image()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_source_image | ( | scanbotsdk_barcode_item_t * | self, |
| scanbotsdk_image_t ** | source_image ) |
Returns value of source_image field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
A crop from the input image containing the barcode.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t source_image Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_structured_append_info()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_structured_append_info | ( | scanbotsdk_barcode_item_t * | self, |
| scanbotsdk_structured_append_info_t ** | structured_append_info ) |
Returns value of structured_append_info field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
If this barcode is part of a structured append sequence, this field contains information about the sequence.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t structured_append_info Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_text()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_text | ( | scanbotsdk_barcode_item_t * | self, |
| const char ** | text ) |
Returns value of text field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Text contained in the barcode. Binary data is returned in the rawBytes field only.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t text Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_item_get_upc_ean_extension()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_upc_ean_extension | ( | scanbotsdk_barcode_item_t * | self, |
| const char ** | upc_ean_extension ) |
Returns value of upc_ean_extension field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
If this is a UPC/EAN barcode that has an EAN-2 or EAN-5 extension, this field contains the extension value. Requires the UPC_EAN_EXTENSION format to be enabled in the decoding options.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_item_t upc_ean_extension Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_clear_frame_accumulation_cache()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_clear_frame_accumulation_cache | ( | scanbotsdk_barcode_scanner_t * | self | ) |
Clear the cache of the barcode frame accumulator.
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_barcode_scanner_t method to be called on
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_create | ( | scanbotsdk_barcode_format_configuration_base_t ** | barcode_format_configurations, |
| size_t | barcode_format_configurations_size, | ||
| scanbotsdk_barcode_document_format_t * | extracted_document_formats, | ||
| size_t | extracted_document_formats_size, | ||
| bool | only_accept_documents, | ||
| bool | return_barcode_image, | ||
| scanbotsdk_accelerator_t * | accelerator, | ||
| scanbotsdk_barcode_scanner_engine_mode_t | engine_mode, | ||
| scanbotsdk_barcode_accumulation_configuration_t * | accumulation_config, | ||
| bool | optimized_for_overlays, | ||
| scanbotsdk_processing_mode_t | processing_mode, | ||
| scanbotsdk_barcode_scanner_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_scanner_configuration 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
-
barcode_format_configurations Options for barcode decoding. Entries of the array must not be null. barcode_format_configurations_size Size of the array barcode_format_configurations extracted_document_formats List of document formats to be extracted. Barcodes that decode to one of the extracted document formats will have extractedDocument field in BarcodeItem populated with the parsed document. By default all supported barcode document formats are accepted. If empty, no barcodes will be parsed into documents. To only accept the document formats listed in extractedDocumentFormats, the property onlyAcceptDocuments must be true. extracted_document_formats_size Size of the array extracted_document_formats only_accept_documents If true and extractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored.
Default is false
- Parameters
-
return_barcode_image If true, the barcode image will be returned in the BarcodeItem.
Default is false
- Parameters
-
accelerator Accelerator to use for running machine learning models. Is applied only for live mode scanning. The value can be null. engine_mode The engine mode for barcode scanning.
Default is NEXT_GEN
- Parameters
-
accumulation_config Configuration to accumulate barcodes across multiple frames in live mode. The value must not be null. optimized_for_overlays If true, the quads of linear (1D) barcodes will be further refined to more closely match the barcode's outline in the input image. This will also produce stabler barcode outlines across frames for use cases such as AR.
Default is false
- Parameters
-
processing_mode Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
Default is AUTO
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_barcode_scanner_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_create_with_defaults | ( | scanbotsdk_barcode_scanner_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_barcode_scanner_configuration_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_barcode_scanner_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_free | ( | scanbotsdk_barcode_scanner_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_scanner_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_get_accelerator()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_accelerator | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_accelerator_t ** | accelerator ) |
Returns value of accelerator field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Accelerator to use for running machine learning models. Is applied only for live mode scanning.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t accelerator Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_get_accumulation_config()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_accumulation_config | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_barcode_accumulation_configuration_t ** | accumulation_config ) |
Returns value of accumulation_config field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Configuration to accumulate barcodes across multiple frames in live mode.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t accumulation_config Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_get_barcode_format_configurations()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_barcode_format_configurations | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_barcode_format_configuration_base_t ** | barcode_format_configurations, | ||
| size_t | size ) |
Returns value of barcode_format_configurations field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
Options for barcode decoding.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t size Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function. barcode_format_configurations Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_get_barcode_format_configurations_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_barcode_format_configurations_size | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| size_t * | size ) |
Returns size of barcode_format_configurations array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_get_engine_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_engine_mode | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_barcode_scanner_engine_mode_t * | engine_mode ) |
Returns value of engine_mode field of the given object.
The engine mode for barcode scanning.
Default is NEXT_GEN
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t engine_mode Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_get_extracted_document_formats()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_extracted_document_formats | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_barcode_document_format_t ** | extracted_document_formats ) |
Returns value of extracted_document_formats field of the given object. The returned value is direct view into memory, no pre-allocations needed.
List of document formats to be extracted. Barcodes that decode to one of the extracted document formats will have extractedDocument field in BarcodeItem populated with the parsed document. By default all supported barcode document formats are accepted. If empty, no barcodes will be parsed into documents. To only accept the document formats listed in extractedDocumentFormats, the property onlyAcceptDocuments must be true.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t extracted_document_formats Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_get_extracted_document_formats_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_extracted_document_formats_size | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| size_t * | size ) |
Returns size of extracted_document_formats array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_get_only_accept_documents()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_only_accept_documents | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| bool * | only_accept_documents ) |
Returns value of only_accept_documents field of the given object.
If true and extractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t only_accept_documents Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_get_optimized_for_overlays()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_optimized_for_overlays | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| bool * | optimized_for_overlays ) |
Returns value of optimized_for_overlays field of the given object.
If true, the quads of linear (1D) barcodes will be further refined to more closely match the barcode's outline in the input image. This will also produce stabler barcode outlines across frames for use cases such as AR.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t optimized_for_overlays Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_get_processing_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_processing_mode | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_processing_mode_t * | processing_mode ) |
Returns value of processing_mode field of the given object.
Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
Default is AUTO
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t processing_mode Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_get_return_barcode_image()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_return_barcode_image | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| bool * | return_barcode_image ) |
Returns value of return_barcode_image field of the given object.
If true, the barcode image will be returned in the BarcodeItem.
Default is false
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_configuration_t return_barcode_image Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_configuration_set_accelerator()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_accelerator | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_accelerator_t * | accelerator ) |
Sets value of accelerator field of the given object.
Accelerator to use for running machine learning models. Is applied only for live mode scanning.
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_barcode_scanner_configuration_t, the field of which will be set accelerator The value to be set. Can be null.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_set_accumulation_config()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_accumulation_config | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_barcode_accumulation_configuration_t * | accumulation_config ) |
Sets value of accumulation_config field of the given object.
Configuration to accumulate barcodes across multiple frames in live mode.
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_barcode_scanner_configuration_t, the field of which will be set accumulation_config The value to be set. Must not be null.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_set_barcode_format_configurations()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_barcode_format_configurations | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_barcode_format_configuration_base_t ** | barcode_format_configurations, | ||
| size_t | barcode_format_configurations_size ) |
Sets value of barcode_format_configurations field of the given object.
Options for barcode decoding.
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_barcode_scanner_configuration_t, the field of which will be set barcode_format_configurations The value to be set. barcode_format_configurations_size Size of the array.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_set_engine_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_engine_mode | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_barcode_scanner_engine_mode_t | engine_mode ) |
Sets value of engine_mode field of the given object.
The engine mode for barcode scanning.
Default is NEXT_GEN
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_barcode_scanner_configuration_t, the field of which will be set engine_mode The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_set_extracted_document_formats()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_extracted_document_formats | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_barcode_document_format_t * | extracted_document_formats, | ||
| size_t | extracted_document_formats_size ) |
Sets value of extracted_document_formats field of the given object.
List of document formats to be extracted. Barcodes that decode to one of the extracted document formats will have extractedDocument field in BarcodeItem populated with the parsed document. By default all supported barcode document formats are accepted. If empty, no barcodes will be parsed into documents. To only accept the document formats listed in extractedDocumentFormats, the property onlyAcceptDocuments must be true.
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_barcode_scanner_configuration_t, the field of which will be set extracted_document_formats The value to be set. extracted_document_formats_size Size of the array.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_set_only_accept_documents()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_only_accept_documents | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| bool | only_accept_documents ) |
Sets value of only_accept_documents field of the given object.
If true and extractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored.
Default is false
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_barcode_scanner_configuration_t, the field of which will be set only_accept_documents The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_set_optimized_for_overlays()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_optimized_for_overlays | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| bool | optimized_for_overlays ) |
Sets value of optimized_for_overlays field of the given object.
If true, the quads of linear (1D) barcodes will be further refined to more closely match the barcode's outline in the input image. This will also produce stabler barcode outlines across frames for use cases such as AR.
Default is false
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_barcode_scanner_configuration_t, the field of which will be set optimized_for_overlays The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_set_processing_mode()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_processing_mode | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| scanbotsdk_processing_mode_t | processing_mode ) |
Sets value of processing_mode field of the given object.
Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
Default is AUTO
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_barcode_scanner_configuration_t, the field of which will be set processing_mode The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_configuration_set_return_barcode_image()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_return_barcode_image | ( | scanbotsdk_barcode_scanner_configuration_t * | self, |
| bool | return_barcode_image ) |
Sets value of return_barcode_image field of the given object.
If true, the barcode image will be returned in the BarcodeItem.
Default is false
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_barcode_scanner_configuration_t, the field of which will be set return_barcode_image The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_create | ( | scanbotsdk_barcode_scanner_configuration_t * | configuration, |
| scanbotsdk_barcode_scanner_t ** | result ) |
Creates a new instance of scanbotsdk_barcode_scanner 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
-
configuration The configuration to use for the barcode scanner. The value must not be null. result Pointer to a variable that will store the created instance of scanbotsdk_barcode_scanner_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_engine_mode_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_engine_mode_t_to_string | ( | scanbotsdk_barcode_scanner_engine_mode_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_barcode_scanner_engine_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_barcode_scanner_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_free | ( | scanbotsdk_barcode_scanner_t * | self | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_scanner_t. If null is passed, the function does nothing.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_result_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_free | ( | scanbotsdk_barcode_scanner_result_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_barcode_scanner_result_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_barcode_scanner_result_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_barcode_scanner_result_get_barcodes()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_get_barcodes | ( | scanbotsdk_barcode_scanner_result_t * | self, |
| scanbotsdk_barcode_item_t ** | barcodes, | ||
| size_t | size ) |
Returns value of barcodes field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
List of found barcodes.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_result_t size Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function. barcodes Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_result_get_barcodes_size()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_get_barcodes_size | ( | scanbotsdk_barcode_scanner_result_t * | self, |
| size_t * | size ) |
Returns size of barcodes array.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_result_t size Pointer to a variable that will store the size.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_result_get_success()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_get_success | ( | scanbotsdk_barcode_scanner_result_t * | self, |
| bool * | success ) |
Returns value of success field of the given object.
True if any barcodes were found.
- Parameters
-
self Pointer to the instance of scanbotsdk_barcode_scanner_result_t success Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_barcode_scanner_run()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_run | ( | scanbotsdk_barcode_scanner_t * | self, |
| scanbotsdk_image_t * | image, | ||
| scanbotsdk_barcode_scanner_result_t ** | result ) |
Recognize barcodes in the given image.
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_barcode_scanner_t method to be called on image The image to recognize barcodes in. The value must not be null. result Pointer to a variable that will store the created instance of scanbotsdk_barcode_scanner_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_character_encoding_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_character_encoding_t_to_string | ( | scanbotsdk_character_encoding_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_character_encoding_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_gs_1_handling_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_gs_1_handling_t_to_string | ( | scanbotsdk_gs_1_handling_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_gs_1_handling_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_msi_plessey_checksum_algorithm_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_msi_plessey_checksum_algorithm_t_to_string | ( | scanbotsdk_msi_plessey_checksum_algorithm_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_msi_plessey_checksum_algorithm_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_range_encoding_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_range_encoding_create | ( | int | start, |
| int | end, | ||
| scanbotsdk_character_encoding_t | encoding, | ||
| scanbotsdk_range_encoding_t ** | result ) |
Creates a new instance of scanbotsdk_range_encoding 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
-
start Start index of the range. end End index of the range (inclusive). encoding Character encoding for the given range. result Pointer to a variable that will store the created instance of scanbotsdk_range_encoding_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_range_encoding_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_range_encoding_free | ( | scanbotsdk_range_encoding_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_range_encoding_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_range_encoding_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_range_encoding_get_encoding()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_range_encoding_get_encoding | ( | scanbotsdk_range_encoding_t * | self, |
| scanbotsdk_character_encoding_t * | encoding ) |
Returns value of encoding field of the given object.
Character encoding for the given range.
- Parameters
-
self Pointer to the instance of scanbotsdk_range_encoding_t encoding Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_range_encoding_get_end()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_range_encoding_get_end | ( | scanbotsdk_range_encoding_t * | self, |
| int * | end ) |
Returns value of end field of the given object.
End index of the range (inclusive).
- Parameters
-
self Pointer to the instance of scanbotsdk_range_encoding_t end Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_range_encoding_get_start()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_range_encoding_get_start | ( | scanbotsdk_range_encoding_t * | self, |
| int * | start ) |
Returns value of start field of the given object.
Start index of the range.
- Parameters
-
self Pointer to the instance of scanbotsdk_range_encoding_t start Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_structured_append_info_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_structured_append_info_create | ( | int | count, |
| int | index, | ||
| const char * | id, | ||
| scanbotsdk_structured_append_info_t ** | result ) |
Creates a new instance of scanbotsdk_structured_append_info 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
-
count The number of barcodes in the structured append set. index The index of the barcode in the structured append set. id The ID of the structured append set. The value must not be null. result Pointer to a variable that will store the created instance of scanbotsdk_structured_append_info_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_structured_append_info_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_structured_append_info_free | ( | scanbotsdk_structured_append_info_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_structured_append_info_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_structured_append_info_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_structured_append_info_get_count()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_structured_append_info_get_count | ( | scanbotsdk_structured_append_info_t * | self, |
| int * | count ) |
Returns value of count field of the given object.
The number of barcodes in the structured append set.
- Parameters
-
self Pointer to the instance of scanbotsdk_structured_append_info_t count Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_structured_append_info_get_id()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_structured_append_info_get_id | ( | scanbotsdk_structured_append_info_t * | self, |
| const char ** | id ) |
Returns value of id field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
The ID of the structured append set.
- Parameters
-
self Pointer to the instance of scanbotsdk_structured_append_info_t id Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_structured_append_info_get_index()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_structured_append_info_get_index | ( | scanbotsdk_structured_append_info_t * | self, |
| int * | index ) |
Returns value of index field of the given object.
The index of the barcode in the structured append set.
- Parameters
-
self Pointer to the instance of scanbotsdk_structured_append_info_t index Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_upc_ean_extension_behavior_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_upc_ean_extension_behavior_t_to_string | ( | scanbotsdk_upc_ean_extension_behavior_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_upc_ean_extension_behavior_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.
Generated by
1.13.2