ScBarcode.h File Reference

Go to the source code of this file.

Typedefs
typedef struct ScOpaqueBarcode	ScBarcode

Enumerations
enum	ScSymbology {   SC_SYMBOLOGY_UNKNOWN = 0, SC_SYMBOLOGY_EAN13 = 1, SC_SYMBOLOGY_EAN8 = 2, SC_SYMBOLOGY_UPCA = 3,   SC_SYMBOLOGY_UPCE = 4, SC_SYMBOLOGY_CODE128 = 5, SC_SYMBOLOGY_CODE39 = 6, SC_SYMBOLOGY_CODE93 = 7,   SC_SYMBOLOGY_INTERLEAVED_2_OF_5 = 8, SC_SYMBOLOGY_QR = 9, SC_SYMBOLOGY_DATA_MATRIX = 10, SC_SYMBOLOGY_PDF417 = 11,   SC_SYMBOLOGY_MSI_PLESSEY = 12, SC_SYMBOLOGY_GS1_DATABAR = 13, SC_SYMBOLOGY_GS1_DATABAR_EXPANDED = 14, SC_SYMBOLOGY_CODABAR = 15,   SC_SYMBOLOGY_AZTEC = 16, SC_SYMBOLOGY_TWO_DIGIT_ADD_ON = 17, SC_SYMBOLOGY_FIVE_DIGIT_ADD_ON = 18, SC_SYMBOLOGY_MAXICODE = 19,   SC_SYMBOLOGY_CODE11 = 20, SC_SYMBOLOGY_GS1_DATABAR_LIMITED = 21, SC_SYMBOLOGY_CODE25 = 22, SC_SYMBOLOGY_MICRO_PDF417 = 23,   SC_SYMBOLOGY_RM4SCC = 24, SC_SYMBOLOGY_KIX = 25, SC_SYMBOLOGY_DOTCODE = 26, SC_SYMBOLOGY_MICRO_QR = 27,   SC_SYMBOLOGY_CODE32 = 28, SC_SYMBOLOGY_LAPA4SC = 29, SC_SYMBOLOGY_IATA_2_OF_5 = 30, SC_SYMBOLOGY_MATRIX_2_OF_5 = 31,   SC_SYMBOLOGY_USPS_INTELLIGENT_MAIL = 32, SC_SYMBOLOGY_ARUCO = 33, SC_SYMBOLOGY_UPU_4STATE = 34, SC_SYMBOLOGY_AUSTRALIAN_POST_4STATE = 35,   SC_SYMBOLOGY_FRENCH_POST = 36 }
enum	ScCompositeFlag {   SC_COMPOSITE_FLAG_NONE = 0, SC_COMPOSITE_FLAG_UNKNOWN = 1, SC_COMPOSITE_FLAG_LINKED = 2, SC_COMPOSITE_FLAG_GS1_A = 3,   SC_COMPOSITE_FLAG_GS1_B = 4, SC_COMPOSITE_FLAG_GS1_C = 5 }

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

Variables
SC_EXTERN ScSymbology const	SC_ALL_SYMBOLOGIES []
SC_EXTERN uint16_t const	SC_ALL_SYMBOLOGIES_COUNT

Detailed Description

Functions for retrieving barcode information.

Copyright

Copyright (c) 2015 Scandit AG. All rights reserved.

Enumeration Type Documentation

enum 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)
SC_SYMBOLOGY_LAPA4SC	Posti LAPA (Lajittelupalvelu) 4 State Code
SC_SYMBOLOGY_IATA_2_OF_5	IATA (International Air Transport Association) 2 of 5
SC_SYMBOLOGY_MATRIX_2_OF_5	Matrix 2 of 5
SC_SYMBOLOGY_USPS_INTELLIGENT_MAIL	Intelligent Mail
SC_SYMBOLOGY_ARUCO	ArUco AR marker Since 5.29.0
SC_SYMBOLOGY_UPU_4STATE	UPU 4 State Since 5.32.0
SC_SYMBOLOGY_AUSTRALIAN_POST_4STATE	Australian Post 4 State Since 5.35.0
SC_SYMBOLOGY_FRENCH_POST	French-Post Since 5.36.0

enum 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

char const* sc_symbology_to_string

(

ScSymbology

symbology

)

Helper function to convert the symbology enum to a string.

Parameters

symbology

symbology id

Returns

pointer to a constant character array.

Since

4.6.0

Examples:

CommandLineBarcodeScannerImageProcessingSample.c, and CommandLineMatrixScanCameraSample.c.

ScSymbology sc_symbology_from_string

(

char const *

symbology_string

)

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

Parameters

symbology_string

string with symbology name

Returns

the enum value for the given symbology string

Since

5.5.0

Variable Documentation

SC_EXTERN ScSymbology const 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.