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 {
32  SC_CHECKSUM_NONE = 0x00,
36  SC_CHECKSUM_MOD_10 = 0x01,
40  SC_CHECKSUM_MOD_11 = 0x02,
44  SC_CHECKSUM_MOD_47 = 0x04,
48  SC_CHECKSUM_MOD_103 = 0x10,
52  SC_CHECKSUM_MOD_1010 = 0x20,
56  SC_CHECKSUM_MOD_1110 = 0x40,
60  SC_CHECKSUM_MOD_43 = 0x100,
64  SC_CHECKSUM_MOD_16 = 0x200,
65 } ScChecksum;
66 
70 typedef int32_t ScChecksums;
71 
78 typedef struct ScOpaqueSymbologySettings ScSymbologySettings;
81 
92 SC_EXPORT ScSymbology
93 sc_symbology_settings_get_symbology(const ScSymbologySettings *settings);
94 
103 SC_EXPORT void
104 sc_symbology_settings_retain(ScSymbologySettings *settings);
105 
116 SC_EXPORT void
117 sc_symbology_settings_release(ScSymbologySettings *settings);
118 
142 SC_EXPORT ScBool
143 sc_symbology_settings_is_enabled(const ScSymbologySettings *settings);
144 
159 SC_EXPORT void
160 sc_symbology_settings_set_enabled(ScSymbologySettings *settings,
161  ScBool enabled);
162 
180 SC_EXPORT ScBool
181 sc_symbology_settings_is_color_inverted_enabled(const ScSymbologySettings *settings);
182 
195 SC_EXPORT void
196 sc_symbology_settings_set_color_inverted_enabled(ScSymbologySettings *settings,
197  ScBool enabled);
198 
221 SC_EXPORT ScChecksums
222 sc_symbology_settings_get_checksums(const ScSymbologySettings *settings);
223 
237 SC_EXPORT void
238 sc_symbology_settings_set_checksums(ScSymbologySettings *settings,
239  ScChecksums checksums);
240 
264 SC_EXPORT ScBool
265 sc_symbology_settings_is_extension_enabled(const ScSymbologySettings *settings,
266  const char *extension);
267 
268 
283 SC_EXPORT void
284 sc_symbology_settings_set_extension_enabled(ScSymbologySettings *settings,
285  const char *extension, ScBool enabled);
286 
297 SC_EXPORT char **
298 sc_symbology_settings_get_enabled_extensions(ScSymbologySettings *settings);
299 
330 SC_EXPORT void
331 sc_symbology_settings_set_active_symbol_counts(ScSymbologySettings * settings, const uint16_t *active_counts,
332  uint16_t num_counts);
333 
351 SC_EXPORT void
352 sc_symbology_settings_get_active_symbol_counts(ScSymbologySettings * settings, uint16_t **active_counts,
353  uint16_t *num_counts);
354 
357 #if defined(__cplusplus)
358 }
359 #endif
360 
361 
362 #endif // SC_SYMBOLOGY_SETTINGS_H_
363 
364 
SC_CHECKSUM_MOD_103
@ SC_CHECKSUM_MOD_103
Checksum is calculating using modulo of 103.
Definition: ScSymbologySettings.h:48
ScSymbologySettings::sc_symbology_settings_is_color_inverted_enabled
ScBool sc_symbology_settings_is_color_inverted_enabled(const ScSymbologySettings *settings)
Determine whether color-inverted decoding of this symbology is enabled.
ScSymbologySettings::sc_symbology_settings_get_enabled_extensions
char ** sc_symbology_settings_get_enabled_extensions(ScSymbologySettings *settings)
Get all enabled extensions for this symbology.
ScSymbologySettings::sc_symbology_settings_get_active_symbol_counts
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.
SC_CHECKSUM_MOD_1110
@ SC_CHECKSUM_MOD_1110
Modulo 11 and a modulo 10 checksum.
Definition: ScSymbologySettings.h:56
ScSymbologySettings::sc_symbology_settings_retain
void sc_symbology_settings_retain(ScSymbologySettings *settings)
Increase reference count of barcode symbology settings by one.
ScSymbologySettings::sc_symbology_settings_release
void sc_symbology_settings_release(ScSymbologySettings *settings)
Decrease reference count of barcode symbology settings by one.
SC_CHECKSUM_MOD_11
@ SC_CHECKSUM_MOD_11
Checksum is calculating using modulo of 11.
Definition: ScSymbologySettings.h:40
SC_CHECKSUM_MOD_1010
@ SC_CHECKSUM_MOD_1010
Two modulo 10 checksums.
Definition: ScSymbologySettings.h:52
ScSymbologySettings::sc_symbology_settings_get_symbology
ScSymbology sc_symbology_settings_get_symbology(const ScSymbologySettings *settings)
Get symbology of the symbology settings object.
SC_CHECKSUM_MOD_10
@ SC_CHECKSUM_MOD_10
Checksum is calculating using modulo of 10.
Definition: ScSymbologySettings.h:36
SC_CHECKSUM_MOD_43
@ SC_CHECKSUM_MOD_43
Modulo 43 checksum, e.g. as used by Code39.
Definition: ScSymbologySettings.h:60
ScConfig.h
Common definitions used throughout the ScanditSDK API.
SC_CHECKSUM_NONE
@ SC_CHECKSUM_NONE
No checksum algorithm.
Definition: ScSymbologySettings.h:32
SC_CHECKSUM_MOD_16
@ SC_CHECKSUM_MOD_16
Modulo 16 checksum, e.g. as used by Codabar.
Definition: ScSymbologySettings.h:64
ScBarcode.h
Functions for retrieving barcode information.
ScSymbologySettings::sc_symbology_settings_is_enabled
ScBool sc_symbology_settings_is_enabled(const ScSymbologySettings *settings)
Determine whether decoding of this symbology is enabled.
ScBool
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:127
ScSymbologySettings::sc_symbology_settings_set_enabled
void sc_symbology_settings_set_enabled(ScSymbologySettings *settings, ScBool enabled)
Enable/disable decoding of this symbology.
ScSymbologySettings::sc_symbology_settings_is_extension_enabled
ScBool sc_symbology_settings_is_extension_enabled(const ScSymbologySettings *settings, const char *extension)
Determine whether a certain extension is enabled for the symbology.
ScSymbology
ScSymbology
Enumeration of all supported 1d and 2d barcode symbologies.
Definition: ScBarcode.h:29
ScChecksums
int32_t ScChecksums
A bit-wise combination of ScChecksum.
Definition: ScSymbologySettings.h:70
ScSymbologySettings::sc_symbology_settings_get_checksums
ScChecksums sc_symbology_settings_get_checksums(const ScSymbologySettings *settings)
Get active optional checksums of this symbology.
ScSymbologySettings::sc_symbology_settings_set_checksums
void sc_symbology_settings_set_checksums(ScSymbologySettings *settings, ScChecksums checksums)
Set active optional checksums for this symbology.
ScSymbologySettings::sc_symbology_settings_set_extension_enabled
void sc_symbology_settings_set_extension_enabled(ScSymbologySettings *settings, const char *extension, ScBool enabled)
Activate/Deactivate a custom extension for the symbology.
ScChecksum
ScChecksum
A list of possible checksum algorithms.
Definition: ScSymbologySettings.h:28
ScSymbologySettings::sc_symbology_settings_set_active_symbol_counts
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.
ScSymbologySettings
Contains symbology-specific settings.
ScSymbologySettings::sc_symbology_settings_set_color_inverted_enabled
void sc_symbology_settings_set_color_inverted_enabled(ScSymbologySettings *settings, ScBool enabled)
Enable/disable decoding of this symbology.
SC_CHECKSUM_MOD_47
@ SC_CHECKSUM_MOD_47
Checksum is calculating using modulo of 47.
Definition: ScSymbologySettings.h:44
Copyright (C) 2020 Scandit AG