Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Android

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 ScSymbology
94 
103 SC_EXPORT void
105 
116 SC_EXPORT void
118 
142 SC_EXPORT ScBool
144 
159 SC_EXPORT void
161  ScBool enabled);
162 
180 SC_EXPORT ScBool
182 
195 SC_EXPORT void
197  ScBool enabled);
198 
221 SC_EXPORT ScChecksums
223 
237 SC_EXPORT void
239  ScChecksums checksums);
240 
264 SC_EXPORT ScBool
266  const char *extension);
267 
268 
283 SC_EXPORT void
285  const char *extension, ScBool enabled);
286 
297 SC_EXPORT char **
299 
329 SC_EXPORT void
330 sc_symbology_settings_set_active_symbol_counts(ScSymbologySettings * settings, const uint16_t *active_counts,
331  uint16_t num_counts);
332 
350 SC_EXPORT void
351 sc_symbology_settings_get_active_symbol_counts(ScSymbologySettings * settings, uint16_t **active_counts,
352  uint16_t *num_counts);
353 
356 #if defined(__cplusplus)
357 }
358 #endif
359 
360 
361 #endif // SC_SYMBOLOGY_SETTINGS_H_
362 
363 
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, e.g. as used by Code39.
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
Modulo 16 checksum, e.g. as used by Codabar.
Definition: ScSymbologySettings.h:64
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.
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:122