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

ScEncodingArray.h
Go to the documentation of this file.
1 
10 #ifndef SC_ENCODING_ARRAY_H_
11 #define SC_ENCODING_ARRAY_H_
12 
13 #include "Scandit/ScByteArray.h"
14 #include "Scandit/ScConfig.h"
15 
16 #if defined(__cplusplus)
17 extern "C" {
18 #endif
19 
23 typedef ScByteArray ScData;
24 
32 SC_EXPORT void
33 sc_data_free(ScData data);
34 
42 typedef struct {
44  ScData encoding;
45  uint32_t start;
46  uint32_t end;
47 } ScEncodingRange;
49 
58 SC_EXPORT void
59 sc_encoding_range_free(ScEncodingRange encoding_range);
60 
73 SC_EXPORT ScEncodingRange
74 sc_encoding_range_new(const char* c_str, uint32_t start, uint32_t end);
75 
83 typedef struct {
85  ScEncodingRange * encodings;
86  uint32_t size;
87 } ScEncodingArray;
89 
100 SC_EXPORT ScEncodingArray
101 sc_encoding_array_new(uint32_t size);
102 
115 SC_EXPORT void
116 sc_encoding_array_assign(ScEncodingArray *array, uint32_t pos, const char * encoding, uint32_t start, uint32_t end);
117 
128 SC_EXPORT uint32_t
129 sc_encoding_array_get_size(ScEncodingArray array);
130 
142 SC_EXPORT ScEncodingRange
143 sc_encoding_array_get_item_at(ScEncodingArray array, uint32_t i);
144 
153 SC_EXPORT void
154 sc_encoding_array_free(ScEncodingArray array);
155 
156 #if defined(__cplusplus)
157 }
158 #endif
159 
160 #endif // SC_BYTE_ARRAY_H_
ScEncodingRange
Character encoding of a range of bytes.
Definition: ScEncodingArray.h:43
ScByteArray.h
Functions to manage an array of bytes.
ScEncodingArray::sc_encoding_array_free
void sc_encoding_array_free(ScEncodingArray array)
Frees the data of the encoding array.
ScEncodingArray::sc_encoding_array_get_item_at
ScEncodingRange sc_encoding_array_get_item_at(ScEncodingArray array, uint32_t i)
Access an encoding range.
ScEncodingArray::sc_encoding_array_get_size
uint32_t sc_encoding_array_get_size(ScEncodingArray array)
Get the number of elements in the array.
ScEncodingRange::sc_encoding_range_free
void sc_encoding_range_free(ScEncodingRange encoding_range)
Frees the data of the encoding range.
ScEncodingRange::end
uint32_t end
index after the last element in the data
Definition: ScEncodingArray.h:46
ScEncodingRange::start
uint32_t start
start index in the data
Definition: ScEncodingArray.h:45
ScEncodingRange::encoding
ScData encoding
encapsulates a charset encoding name as defined by IANA (http://www.iana.org/assignments/character-se...
Definition: ScEncodingArray.h:44
sc_data_free
void sc_data_free(ScData data)
Free the data.
ScEncodingRange::sc_encoding_range_new
ScEncodingRange sc_encoding_range_new(const char *c_str, uint32_t start, uint32_t end)
Create new ScEncodingRange.
ScEncodingArray::sc_encoding_array_new
ScEncodingArray sc_encoding_array_new(uint32_t size)
Create new ScEncodingArray with given size.
ScConfig.h
Common definitions used throughout the ScanditSDK API.
ScEncodingArray::sc_encoding_array_assign
void sc_encoding_array_assign(ScEncodingArray *array, uint32_t pos, const char *encoding, uint32_t start, uint32_t end)
Assigns the value of the element at index pos in the array.
ScEncodingArray
An array of encoding ranges.
Definition: ScEncodingArray.h:84
ScEncodingArray::encodings
ScEncodingRange * encodings
array of ranges
Definition: ScEncodingArray.h:85
ScData
ScByteArray ScData
Represents a binary blob of data, or a string of characters.
Definition: ScEncodingArray.h:23
ScByteArray
A null terminated array of bytes.
ScEncodingArray::size
uint32_t size
number of elements in the array
Definition: ScEncodingArray.h:86
Copyright (C) 2020 Scandit AG