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 (const ScBarcodeArray *array)
 
ScBarcodesc_barcode_array_get_item_at (const ScBarcodeArray *array, uint32_t index)
 

Detailed Description

A fixed-size array of barcode objects.

Since
4.6.0
Examples
CommandLineBarcodeScannerCameraSample.c, and CommandLineBarcodeScannerImageProcessingSample.c.

Member Function Documentation

◆ sc_barcode_array_retain()

void sc_barcode_array_retain ( ScBarcodeArray array)

Increase reference count of barcode array by one.

Parameters
arrayThe barcode array. Must not be null.
Since
4.6.0

◆ sc_barcode_array_release()

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
arraythe barcode array. May be null
Since
4.6.0
Examples
CommandLineBarcodeScannerCameraSample.c, and CommandLineBarcodeScannerImageProcessingSample.c.

◆ sc_barcode_array_get_size()

uint32_t sc_barcode_array_get_size ( const ScBarcodeArray array)

Get the number of barcodes in the array.

Returns
The number of barcodes.
Parameters
arrayThe barcode array. Must not be null.
Since
4.6.0
Examples
CommandLineBarcodeScannerCameraSample.c, and CommandLineBarcodeScannerImageProcessingSample.c.

◆ sc_barcode_array_get_item_at()

ScBarcode * sc_barcode_array_get_item_at ( const ScBarcodeArray 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.
Parameters
arraythe barcode array. Must not be null.
indexthe index of the barcode to retrieve.
Since
4.6.0
Examples
CommandLineBarcodeScannerCameraSample.c, and CommandLineBarcodeScannerImageProcessingSample.c.

The documentation for this struct was generated from the following file: