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 
17 #if defined(__cplusplus)
18 extern "C" {
19 #endif
20 
28 typedef enum {
65 } ScChecksum;
66 
70 typedef int32_t ScChecksums;
71 
78 typedef struct ScOpaqueSymbologySettings ScSymbologySettings;
81 
92 SC_EXPORT
94 
103 SC_EXPORT
105 
116 SC_EXPORT
118 
142 SC_EXPORT
144 
159 SC_EXPORT
161 
179 SC_EXPORT
181 
194 SC_EXPORT
196  ScBool enabled);
197 
220 SC_EXPORT
221 ScChecksums sc_symbology_settings_get_checksums(ScSymbologySettings const *settings);
222 
236 SC_EXPORT
237 void sc_symbology_settings_set_checksums(ScSymbologySettings *settings, ScChecksums checksums);
238 
262 SC_EXPORT
264  char const *extension);
265 
280 SC_EXPORT
282  char const *extension,
283  ScBool enabled);
284 
295 SC_EXPORT
297 
328 SC_EXPORT
330  uint16_t const *active_counts,
331  uint16_t num_counts);
332 
351 SC_EXPORT
353  uint16_t **active_counts,
354  uint16_t *num_counts);
355 
358 #if defined(__cplusplus)
359 }
360 #endif
361 
362 #endif // SC_SYMBOLOGY_SETTINGS_H_
ScChecksum
A list of possible checksum algorithms.
Definition: ScSymbologySettings.h:28
char ** sc_symbology_settings_get_enabled_extensions(ScSymbologySettings *settings)
Get all enabled extensions for this symbology.
Checksum is calculating using modulo of 47.
Definition: ScSymbologySettings.h:44
Checksum is calculating using modulo of 103.
Definition: ScSymbologySettings.h:48
ScBool sc_symbology_settings_is_enabled(ScSymbologySettings const *settings)
Determine whether 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.
Two modulo 10 checksums.
Definition: ScSymbologySettings.h:52
Modulo 11 and a modulo 10 checksum.
Definition: ScSymbologySettings.h:56
Checksum is calculating using modulo of 11.
Definition: ScSymbologySettings.h:40
void sc_symbology_settings_retain(ScSymbologySettings *settings)
Increase reference count of barcode symbology settings by one.
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.
Checksum is calculating using modulo of 10.
Definition: ScSymbologySettings.h:36
Modulo 43 checksum, e.g. as used by Code39.
Definition: ScSymbologySettings.h:60
ScBool sc_symbology_settings_is_color_inverted_enabled(ScSymbologySettings const *settings)
Determine whether color-inverted decoding of this symbology is enabled.
void sc_symbology_settings_release(ScSymbologySettings *settings)
Decrease reference count of barcode symbology settings by one.
Functions for retrieving barcode information.
No checksum algorithm.
Definition: ScSymbologySettings.h:32
ScSymbology
Enumeration of all supported 1d and 2d barcode symbologies.
Definition: ScBarcode.h:29
ScSymbology sc_symbology_settings_get_symbology(ScSymbologySettings const *settings)
Get symbology of the symbology settings object.
Modulo 16 checksum, e.g. as used by Codabar.
Definition: ScSymbologySettings.h:64
void sc_symbology_settings_set_extension_enabled(ScSymbologySettings *settings, char const *extension, ScBool enabled)
Activate/Deactivate a custom extension for the symbology.
int32_t ScChecksums
A bit-wise combination of ScChecksum.
Definition: ScSymbologySettings.h:70
void sc_symbology_settings_set_enabled(ScSymbologySettings *settings, ScBool enabled)
Enable/disable decoding of this symbology.
Common definitions used throughout the ScanditSDK API.
void sc_symbology_settings_set_color_inverted_enabled(ScSymbologySettings *settings, ScBool enabled)
Enable/disable decoding of this symbology.
ScChecksums sc_symbology_settings_get_checksums(ScSymbologySettings const *settings)
Get active optional checksums of this symbology.
void sc_symbology_settings_set_checksums(ScSymbologySettings *settings, ScChecksums checksums)
Set active optional checksums for this symbology.
Contains symbology-specific settings.
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.
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:127