ScBarcode.h File Reference

Go to the source code of this file.

Typedefs

typedef struct ScOpaqueBarcode ScBarcode
 

Enumerations

enum  ScSymbology {
  SC_SYMBOLOGY_UNKNOWN = 0x0000000, SC_SYMBOLOGY_EAN13 = 0x0000001, SC_SYMBOLOGY_EAN8 = 0x0000002, SC_SYMBOLOGY_UPCA = 0x0000004,
  SC_SYMBOLOGY_UPCE = 0x0000008, SC_SYMBOLOGY_CODE128 = 0x0000010, SC_SYMBOLOGY_CODE39 = 0x0000020, SC_SYMBOLOGY_CODE93 = 0x0000040,
  SC_SYMBOLOGY_INTERLEAVED_2_OF_5 = 0x0000080, SC_SYMBOLOGY_QR = 0x0000100, SC_SYMBOLOGY_DATA_MATRIX = 0x0000200, SC_SYMBOLOGY_PDF417 = 0x0000400,
  SC_SYMBOLOGY_MSI_PLESSEY = 0x0000800, SC_SYMBOLOGY_GS1_DATABAR = 0x0001000, SC_SYMBOLOGY_GS1_DATABAR_EXPANDED = 0x0002000, SC_SYMBOLOGY_CODABAR = 0x0004000,
  SC_SYMBOLOGY_AZTEC = 0x0008000, SC_SYMBOLOGY_TWO_DIGIT_ADD_ON = 0x0010000, SC_SYMBOLOGY_FIVE_DIGIT_ADD_ON = 0x0020000, SC_SYMBOLOGY_MAXICODE = 0x0040000,
  SC_SYMBOLOGY_CODE11 = 0x0080000, SC_SYMBOLOGY_GS1_DATABAR_LIMITED = 0x0100000, SC_SYMBOLOGY_CODE25 = 0x0200000, SC_SYMBOLOGY_MICRO_PDF417 = 0x0400000,
  SC_SYMBOLOGY_RM4SCC = 0x0800000, SC_SYMBOLOGY_KIX = 0x1000000, SC_SYMBOLOGY_DOTCODE = 0x2000000, SC_SYMBOLOGY_MICRO_QR = 0x4000000,
  SC_SYMBOLOGY_CODE32 = 0x8000000
}
 
enum  ScCompositeFlag {
  SC_COMPOSITE_FLAG_NONE = 0x0000000, SC_COMPOSITE_FLAG_UNKNOWN = 0x0000001, SC_COMPOSITE_FLAG_LINKED = 0x0000002, SC_COMPOSITE_FLAG_GS1_A = 0x0000004,
  SC_COMPOSITE_FLAG_GS1_B = 0x0000008, SC_COMPOSITE_FLAG_GS1_C = 0x0000010
}
 

Functions

const char * sc_symbology_to_string (ScSymbology symbology)
 
ScSymbology sc_symbology_from_string (const char *symbology_string)
 

Variables

SC_EXTERN const ScSymbology SC_ALL_SYMBOLOGIES []
 
SC_EXTERN const uint16_t SC_ALL_SYMBOLOGIES_COUNT
 

Detailed Description

Functions for retrieving barcode information.

Enumeration Type Documentation

◆ ScSymbology

Enumeration of all supported 1d and 2d barcode symbologies.

Since
4.6.0
Enumerator
SC_SYMBOLOGY_UNKNOWN 

Sentinel value used whenever the symbology is unknown/undefined.

SC_SYMBOLOGY_EAN13 

EAN13

SC_SYMBOLOGY_EAN8 

EAN8

SC_SYMBOLOGY_UPCA 

UPCA

SC_SYMBOLOGY_UPCE 

UPCE

SC_SYMBOLOGY_CODE128 

Code128

SC_SYMBOLOGY_CODE39 

Code39

SC_SYMBOLOGY_CODE93 

Code93

SC_SYMBOLOGY_INTERLEAVED_2_OF_5 

Interleaved 2 of 5 (ITF)

SC_SYMBOLOGY_QR 

QR Code

SC_SYMBOLOGY_DATA_MATRIX 

Data Matrix

SC_SYMBOLOGY_PDF417 

PDF417

SC_SYMBOLOGY_MSI_PLESSEY 

MSI Plessey

SC_SYMBOLOGY_GS1_DATABAR 

GS1 DataBar

SC_SYMBOLOGY_GS1_DATABAR_EXPANDED 

GS1 DataBar Expanded

SC_SYMBOLOGY_CODABAR 

Codabar

SC_SYMBOLOGY_AZTEC 

Aztec code

SC_SYMBOLOGY_TWO_DIGIT_ADD_ON 

EAN/UPC two-digit add-on

Also known as EAN/UPC extension or supplemental code.

SC_SYMBOLOGY_FIVE_DIGIT_ADD_ON 

EAN/UPC five-digit add-on

Also known as EAN/UPC extension or supplemental code.

SC_SYMBOLOGY_MAXICODE 

MaxiCode

SC_SYMBOLOGY_CODE11 

Code 11

SC_SYMBOLOGY_GS1_DATABAR_LIMITED 

Databar Limited

SC_SYMBOLOGY_CODE25 

Code25

Also known as 'Industrial 2 of 5', 'Standard 2 of 5' or 'Discrete 2 of 5'

SC_SYMBOLOGY_MICRO_PDF417 

Micro PDF417

SC_SYMBOLOGY_RM4SCC 

Royal Mail 4 State Customer Code

SC_SYMBOLOGY_KIX 

KIX postal code symbology

SC_SYMBOLOGY_DOTCODE 

DotCode

SC_SYMBOLOGY_MICRO_QR 

Micro QR

SC_SYMBOLOGY_CODE32 

Italian Pharma Code (Code32)

◆ ScCompositeFlag

Flags to hint that two codes form a composite code.

Since
4.14.0
Enumerator
SC_COMPOSITE_FLAG_NONE 

Code is not part of a composite code.

SC_COMPOSITE_FLAG_UNKNOWN 

Code could be part of a composite code. This flag is set by linear (1d) symbologies that have no composite flag support but can be part of a composite code like the EAN/UPC symbology family.

SC_COMPOSITE_FLAG_LINKED 

Code is the linear component of a composite code. This flag can be set by GS1 DataBar or GS1-128 (Code 128).

SC_COMPOSITE_FLAG_GS1_A 

Code is a GS1 Composite Code Type A (CC-A). This flag can be set by MicroPDF417 codes.

SC_COMPOSITE_FLAG_GS1_B 

Code is a GS1 Composite Code Type B (CC-B). This flag can be set by MicroPDF417 codes.

SC_COMPOSITE_FLAG_GS1_C 

Code is a GS1 Composite Code Type C (CC-C). This flag can be set by PDF417 codes.

Function Documentation

◆ sc_symbology_to_string()

const char* sc_symbology_to_string ( ScSymbology  symbology)

Helper function to convert the symbology enum to a string.

Parameters
symbologysymbology id
Returns
pointer to a constant character array.
Since
4.6.0
Examples:
CommandLineBarcodeScannerImageProcessingSample.c, and CommandLineMatrixScanCameraSample.c.

◆ sc_symbology_from_string()

ScSymbology sc_symbology_from_string ( const char *  symbology_string)

Helper function to convert a symbology string to its corresponding symbology enum.

Parameters
symbology_stringstring with symbology name
Returns
the enum value for the given symbology string
Since
5.5.0

Variable Documentation

◆ SC_ALL_SYMBOLOGIES

SC_EXTERN const ScSymbology SC_ALL_SYMBOLOGIES[]

Array holding all symbologies supported by the scandit barcode scanner.

The array has a total number of SC_ALL_SYMBOLOGIES_COUNT elements.