ScBarcodeArray Struct Reference
Public Member Functions | |
void sc_barcode_array_retain (ScBarcodeArray *array) | |
void sc_barcode_array_release (ScBarcodeArray *array) | |
uint32_t sc_barcode_array_get_size (ScBarcodeArray const *array) | |
ScBarcode * sc_barcode_array_get_item_at (ScBarcodeArray const *array, uint32_t index) | |
Detailed Description
A fixed-size array of barcode objects.
- Since
- 4.6.0
Member Function Documentation
void sc_barcode_array_retain | ( | ScBarcodeArray * | array | ) |
Increase reference count of barcode array by one.
- Parameters
-
array The barcode array. Must not be null.
- Since
- 4.6.0
void sc_barcode_array_release | ( | ScBarcodeArray * | array | ) |
Decrease reference count of barcode array by one.
When the reference count drops to zero, the barcode array is deallocated.
- Parameters
-
array the barcode array. May be null
- Since
- 4.6.0
uint32_t sc_barcode_array_get_size | ( | ScBarcodeArray const * | array | ) |
Get the number of barcodes in the array.
- Returns
- The number of barcodes.
- Parameters
-
array The barcode array. Must not be null.
- Since
- 4.6.0
ScBarcode * sc_barcode_array_get_item_at | ( | ScBarcodeArray const * | array, |
uint32_t | index | ||
) |
Get barcode at specific index in array.
- Returns
- The barcode at the specific index. In case the index is out of bounds, a NULL barcode is returned.
NOTE: The returned barcode does not have to be freed manually. It is bound to the lifetime of the barcode array.
- Parameters
-
array the barcode array. Must not be null. index the index of the barcode to retrieve.
- Since
- 4.6.0
The documentation for this struct was generated from the following file: