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
33 void sc_data_free(ScData data);
34 
42 typedef struct {
44  ScData encoding;
45  uint32_t start;
47  uint32_t end;
50 
59 SC_EXPORT
60 void sc_encoding_range_free(ScEncodingRange encoding_range);
61 
74 SC_EXPORT
75 ScEncodingRange sc_encoding_range_new(char const *c_str, uint32_t start, uint32_t end);
76 
84 typedef struct {
87  uint32_t size;
90 
101 SC_EXPORT
103 
116 SC_EXPORT
118  ScEncodingArray *array, uint32_t pos, char const *encoding, uint32_t start, uint32_t end);
119 
130 SC_EXPORT
132 
144 SC_EXPORT
146 
155 SC_EXPORT
157 
158 #if defined(__cplusplus)
159 }
160 #endif
161 
162 #endif // SC_BYTE_ARRAY_H_
Character encoding of a range of bytes.
Definition: ScEncodingArray.h:43
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.
void sc_encoding_array_assign(ScEncodingArray *array, uint32_t pos, char const *encoding, uint32_t start, uint32_t end)
Assigns the value of the element at index pos in the array.
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:47
ScData encoding
Definition: ScEncodingArray.h:44
void sc_data_free(ScData data)
Free the data.
ScEncodingArray sc_encoding_array_new(uint32_t size)
Create new ScEncodingArray with given size.
Common definitions used throughout the ScanditSDK API.
An array of encoding ranges.
Definition: ScEncodingArray.h:85
ScEncodingRange * encodings
array of ranges
Definition: ScEncodingArray.h:86
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:87
ScEncodingRange sc_encoding_range_new(char const *c_str, uint32_t start, uint32_t end)
Create new ScEncodingRange.