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 
24 
32 SC_EXPORT void sc_data_free(ScData data);
33 
41 typedef struct {
43  ScData encoding;
44  uint32_t start;
46  uint32_t end;
49 
58 SC_EXPORT void sc_encoding_range_free(ScEncodingRange encoding_range);
59 
72 SC_EXPORT ScEncodingRange sc_encoding_range_new(const char *c_str, uint32_t start, uint32_t end);
73 
81 typedef struct {
84  uint32_t size;
87 
98 SC_EXPORT ScEncodingArray sc_encoding_array_new(uint32_t size);
99 
112 SC_EXPORT void sc_encoding_array_assign(
113  ScEncodingArray *array, uint32_t pos, const char *encoding, uint32_t start, uint32_t end);
114 
125 SC_EXPORT uint32_t sc_encoding_array_get_size(ScEncodingArray array);
126 
139 
148 SC_EXPORT void sc_encoding_array_free(ScEncodingArray array);
149 
150 #if defined(__cplusplus)
151 }
152 #endif
153 
154 #endif // SC_BYTE_ARRAY_H_
Character encoding of a range of bytes.
Definition: ScEncodingArray.h:42
Functions to manage an array of bytes.
void sc_encoding_array_free(ScEncodingArray array)
Frees the data of the encoding array.
ScEncodingRange sc_encoding_array_get_item_at(ScEncodingArray array, uint32_t i)
Access an encoding range.
uint32_t sc_encoding_array_get_size(ScEncodingArray array)
Get the number of elements in the array.
void sc_encoding_range_free(ScEncodingRange encoding_range)
Frees the data of the encoding range.
uint32_t end
index after the last element in the data
Definition: ScEncodingArray.h:46
ScData encoding
Definition: ScEncodingArray.h:43
void sc_data_free(ScData data)
Free the data.
ScEncodingRange sc_encoding_range_new(const char *c_str, uint32_t start, uint32_t end)
Create new ScEncodingRange.
ScEncodingArray sc_encoding_array_new(uint32_t size)
Create new ScEncodingArray with given size.
Common definitions used throughout the ScanditSDK API.
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.
An array of encoding ranges.
Definition: ScEncodingArray.h:82
ScEncodingRange * encodings
array of ranges
Definition: ScEncodingArray.h:83
ScByteArray ScData
Represents a binary blob of data, or a string of characters.
Definition: ScEncodingArray.h:23
A null terminated array of bytes.
uint32_t size
number of elements in the array
Definition: ScEncodingArray.h:84