ScSymbologySettings.h
Go to the documentation of this file.
1
11#ifndef SC_SYMBOLOGY_SETTINGS_H_
12#define SC_SYMBOLOGY_SETTINGS_H_
13
14#include <Scandit/ScConfig.h>
15#include <Scandit/ScBarcode.h>
16
18
26typedef enum {
64
68typedef int32_t ScChecksums;
69
76typedef struct ScOpaqueSymbologySettings ScSymbologySettings;
77
88SC_EXPORT
90
99SC_EXPORT
101
112SC_EXPORT
114
138SC_EXPORT
140
155SC_EXPORT
157
175SC_EXPORT
177
190SC_EXPORT
192 ScBool enabled);
217SC_EXPORT
219
233SC_EXPORT
235
258SC_EXPORT
260 char const *extension);
261
277SC_EXPORT
279 char const *extension,
280 ScBool enabled);
281
292SC_EXPORT
294
326SC_EXPORT
328 uint16_t const *active_counts,
329 uint16_t num_counts);
330
349SC_EXPORT
351 uint16_t **active_counts,
352 uint16_t *num_counts);
353
368SC_EXPORT
370
385SC_EXPORT
387
391
392#endif // SC_SYMBOLOGY_SETTINGS_H_
Functions for retrieving barcode information.
ScSymbology
Enumeration of all supported 1d and 2d barcode symbologies.
Definition: ScBarcode.h:27
Common definitions used throughout the ScanditSDK API.
#define SC_EXTERN_C_BEGIN
Start of external C code.
Definition: ScConfig.h:19
#define SC_EXTERN_C_END
End of external C code.
Definition: ScConfig.h:28
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:167
ScChecksum
A list of possible checksum algorithms.
Definition: ScSymbologySettings.h:26
@ SC_CHECKSUM_MOD_1010
Two modulo 10 checksums.
Definition: ScSymbologySettings.h:50
@ SC_CHECKSUM_MOD_16
Modulo 16 checksum, e.g. as used by Codabar.
Definition: ScSymbologySettings.h:62
@ SC_CHECKSUM_MOD_11
Checksum is calculating using modulo of 11.
Definition: ScSymbologySettings.h:38
@ SC_CHECKSUM_MOD_47
Checksum is calculating using modulo of 47.
Definition: ScSymbologySettings.h:42
@ SC_CHECKSUM_NONE
No checksum algorithm.
Definition: ScSymbologySettings.h:30
@ SC_CHECKSUM_MOD_103
Checksum is calculating using modulo of 103.
Definition: ScSymbologySettings.h:46
@ SC_CHECKSUM_MOD_10
Checksum is calculating using modulo of 10.
Definition: ScSymbologySettings.h:34
@ SC_CHECKSUM_MOD_1110
Modulo 11 and a modulo 10 checksum.
Definition: ScSymbologySettings.h:54
@ SC_CHECKSUM_MOD_43
Modulo 43 checksum, e.g. as used by Code39.
Definition: ScSymbologySettings.h:58
int32_t ScChecksums
A bit-wise combination of ScChecksum.
Definition: ScSymbologySettings.h:68
Contains symbology-specific settings.
void sc_symbology_settings_set_active_symbol_counts(ScSymbologySettings *settings, uint16_t const *active_counts, uint16_t num_counts)
This function allows to control the length of barcodes to be decoded.
void sc_symbology_settings_set_extension_enabled(ScSymbologySettings *settings, char const *extension, ScBool enabled)
Activate/Deactivate a custom extension for the symbology.
void sc_symbology_settings_set_ocr_fallback_regex(ScSymbologySettings *settings, char const *regex)
This function allows to constrain the OCR Fallback extension results with a regular expression.
char const * sc_symbology_settings_get_ocr_fallback_regex(ScSymbologySettings const *settings)
Retrieve the OCR Fallback regular expression for this symbology.
char ** sc_symbology_settings_get_enabled_extensions(ScSymbologySettings *settings)
Get all enabled extensions for this symbology.
void sc_symbology_settings_set_enabled(ScSymbologySettings *settings, ScBool enabled)
Enable/disable decoding of this symbology.
void sc_symbology_settings_release(ScSymbologySettings const *settings)
Decrease reference count of barcode symbology settings by one.
void sc_symbology_settings_get_active_symbol_counts(ScSymbologySettings *settings, uint16_t **active_counts, uint16_t *num_counts)
Retrieve the current active symbol counts of this symbology.
ScSymbology sc_symbology_settings_get_symbology(ScSymbologySettings const *settings)
Get symbology of the symbology settings object.
void sc_symbology_settings_retain(ScSymbologySettings const *settings)
Increase reference count of barcode symbology settings by one.
void sc_symbology_settings_set_color_inverted_enabled(ScSymbologySettings *settings, ScBool enabled)
Enable/disable decoding of this symbology.
ScBool sc_symbology_settings_is_enabled(ScSymbologySettings const *settings)
Determine whether decoding of this symbology is enabled.
ScBool sc_symbology_settings_is_color_inverted_enabled(ScSymbologySettings const *settings)
Determine whether color-inverted decoding of this symbology is enabled.
ScBool sc_symbology_settings_is_extension_enabled(ScSymbologySettings const *settings, char const *extension)
Determine whether a certain extension is enabled for the symbology.
void sc_symbology_settings_set_checksums(ScSymbologySettings *settings, ScChecksums checksums)
Set active optional checksums for this symbology.
ScChecksums sc_symbology_settings_get_checksums(ScSymbologySettings const *settings)
Get active optional checksums of this symbology.