ScEncodingArray Struct Reference
#include <Scandit/ScEncodingArray.h>
Public Member Functions | |
| ScEncodingArray | sc_encoding_array_new (uint32_t size) |
| void | sc_encoding_array_assign (ScEncodingArray *array, uint32_t pos, char const *encoding, uint32_t start, uint32_t end) |
| uint32_t | sc_encoding_array_get_size (ScEncodingArray array) |
| ScEncodingRange | sc_encoding_array_get_item_at (ScEncodingArray array, uint32_t i) |
| void | sc_encoding_array_free (ScEncodingArray array) |
Data Fields | |
| ScEncodingRange * | encodings |
| uint32_t | size |
Detailed Description
An array of encoding ranges.
- Since
- 5.8.0
Member Function Documentation
◆ sc_encoding_array_new()
| ScEncodingArray sc_encoding_array_new | ( | uint32_t | size | ) |
Create new ScEncodingArray with given size.
- Returns
- The created ScEncodingArray.
- Parameters
-
size The array size.
- Since
- 5.8.0
◆ sc_encoding_array_assign()
| 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.
- Parameters
-
array The encoding array. pos Index, may take any value 0 <= i < size of array. encoding Encoding of the encoding range start Start index in the data corresponding to the encoding range end End index in the data corresponding to the encoding range
- Since
- 5.8.0
◆ sc_encoding_array_get_size()
| uint32_t sc_encoding_array_get_size | ( | ScEncodingArray | array | ) |
Get the number of elements in the array.
- Returns
- The number of elements.
- Parameters
-
array The encoding array.
- Since
- 5.0.0
◆ sc_encoding_array_get_item_at()
| ScEncodingRange sc_encoding_array_get_item_at | ( | ScEncodingArray | array, |
| uint32_t | i | ||
| ) |
Access an encoding range.
- Returns
- the elements at position i
- Parameters
-
array The encoding array. i index in the array
- Since
- 5.0.0
◆ sc_encoding_array_free()
| void sc_encoding_array_free | ( | ScEncodingArray | array | ) |
Frees the data of the encoding array.
- Parameters
-
array The encoding array.
- Since
- 5.0.0
The documentation for this struct was generated from the following file: