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 {
61 } ScChecksum;
62 
66 typedef int32_t ScChecksums;
67 
74 typedef struct ScOpaqueSymbologySettings ScSymbologySettings;
77 
88 SC_EXPORT ScSymbology
90 
99 SC_EXPORT void
101 
112 SC_EXPORT void
114 
138 SC_EXPORT ScBool
140 
155 SC_EXPORT void
157  ScBool enabled);
158 
176 SC_EXPORT ScBool
178 
191 SC_EXPORT void
193  ScBool enabled);
194 
219 SC_EXPORT ScChecksums
221 
235 SC_EXPORT void
237  ScChecksums checksums);
238 
262 SC_EXPORT ScBool
264  const char *extension);
265 
266 
281 SC_EXPORT void
283  const char *extension, ScBool enabled);
284 
295 SC_EXPORT char **
297 
327 SC_EXPORT void
328 sc_symbology_settings_set_active_symbol_counts(ScSymbologySettings * settings, const uint16_t *active_counts,
329  uint16_t num_counts);
330 
348 SC_EXPORT void
349 sc_symbology_settings_get_active_symbol_counts(ScSymbologySettings * settings, uint16_t **active_counts,
350  uint16_t *num_counts);
351 
354 #if defined(__cplusplus)
355 }
356 #endif
357 
358 
359 #endif // SC_SYMBOLOGY_SETTINGS_H_
360 
361 
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_color_inverted_enabled(const ScSymbologySettings *settings)
Determine whether color-inverted decoding of this symbology is enabled.
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.
ScSymbology sc_symbology_settings_get_symbology(const ScSymbologySettings *settings)
Get symbology of the symbology settings object.
Checksum is calculating using modulo of 10.
Definition: ScSymbologySettings.h:36
Modulo 43 checksum.
Definition: ScSymbologySettings.h:60
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
int32_t ScChecksums
A bit-wise combination of ScChecksum.
Definition: ScSymbologySettings.h:66
void sc_symbology_settings_set_enabled(ScSymbologySettings *settings, ScBool enabled)
Enable/disable decoding of this symbology.
Common definitions used throughout the ScanditSDK API.
ScBool sc_symbology_settings_is_enabled(const ScSymbologySettings *settings)
Determine whether decoding of this symbology is enabled.
ScBool sc_symbology_settings_is_extension_enabled(const ScSymbologySettings *settings, const char *extension)
Determine whether a certain extension is enabled for the symbology.
void sc_symbology_settings_set_color_inverted_enabled(ScSymbologySettings *settings, ScBool enabled)
Enable/disable decoding of this symbology.
void sc_symbology_settings_set_active_symbol_counts(ScSymbologySettings *settings, const uint16_t *active_counts, uint16_t num_counts)
This function allows to control the length of barcodes to be decoded.
void sc_symbology_settings_set_checksums(ScSymbologySettings *settings, ScChecksums checksums)
Set active optional checksums for this symbology.
ScChecksums sc_symbology_settings_get_checksums(const ScSymbologySettings *settings)
Get active optional checksums of this symbology.
Contains symbology-specific settings.
void sc_symbology_settings_set_extension_enabled(ScSymbologySettings *settings, const char *extension, ScBool enabled)
Activate/Deactivate a custom extension for the symbology.
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:123