ScByteArray Struct Reference

Public Member Functions

uint32_t sc_byte_array_get_size (ScByteArray array)
 
const uint8_t * sc_byte_array_get_data (ScByteArray array)
 
const char * sc_byte_array_get_string (ScByteArray array)
 

Detailed Description

A null terminated array of bytes.

The array is always terminated with a null-byte, but null-characters may appear in the middle. Use sc_byte_array_get_size() to get the complete length of the data.

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

Member Function Documentation

◆ sc_byte_array_get_size()

uint32_t sc_byte_array_get_size ( ScByteArray  array)

Get the number of bytes in the array.

Returns
The number of bytes.
Parameters
arrayThe byte array.
Since
4.6.0

◆ sc_byte_array_get_data()

const uint8_t * sc_byte_array_get_data ( ScByteArray  array)

Get a const pointer to the byte data.

Returns
a constant pointer.
Parameters
arrayThe byte array.
Since
4.6.0

◆ sc_byte_array_get_string()

const char * sc_byte_array_get_string ( ScByteArray  array)

Get a const string pointer to the array data.

Returns
a constant pointer.
Parameters
arrayThe byte array.
Since
4.6.0

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