Dynamsoft Barcode Reader 6.3.0 - API Reference
Enumerations

Enumerations

enum  Dynamsoft.Barcode.EnumErrorCode {
  Dynamsoft.Barcode.EnumErrorCode.DBR_AZTEC_LICENSE_INVALID = -10041, Dynamsoft.Barcode.EnumErrorCode.DBR_PARAMETER_VALUE_INVALID = -10038, Dynamsoft.Barcode.EnumErrorCode.DBR_JSON_NAME_REFERENCE_INVALID = -10037, Dynamsoft.Barcode.EnumErrorCode.DBR_TEMPLATE_NAME_INVALID = -10036,
  Dynamsoft.Barcode.EnumErrorCode.DBR_JSON_NAME_VALUE_DUPLICATED = -10035, Dynamsoft.Barcode.EnumErrorCode.DBR_JSON_NAME_KEY_MISSING = -10034, Dynamsoft.Barcode.EnumErrorCode.DBR_JSON_VALUE_INVALID = -10033, Dynamsoft.Barcode.EnumErrorCode.DBR_JSON_KEY_INVALID = -10032,
  Dynamsoft.Barcode.EnumErrorCode.DBR_JSON_TYPE_INVALID = -10031, Dynamsoft.Barcode.EnumErrorCode.DBR_JSON_PARSE_FAILED = -10030, Dynamsoft.Barcode.EnumErrorCode.DBR_RECOGNITION_TIMEOUT = -10026, Dynamsoft.Barcode.EnumErrorCode.DBR_CUSTOM_MODULESIZE_INVALID = -10025,
  Dynamsoft.Barcode.EnumErrorCode.DBR_CUSTOM_SIZE_INVALID = -10024, Dynamsoft.Barcode.EnumErrorCode.DBR_PAGE_NUMBER_INVALID = -10023, Dynamsoft.Barcode.EnumErrorCode.DBR_PDF_DLL_MISSING = -10022, Dynamsoft.Barcode.EnumErrorCode.DBR_PDF_READ_FAILED = -10021,
  Dynamsoft.Barcode.EnumErrorCode.DBR_DATAMATRIX_LICENSE_INVALID = -10020, Dynamsoft.Barcode.EnumErrorCode.DBR_PDF417_LICENSE_INVALID = -10019, Dynamsoft.Barcode.EnumErrorCode.DBR_DIB_BUFFER_INVALID = -10018, Dynamsoft.Barcode.EnumErrorCode.DBR_1D_LICENSE_INVALID = -10017,
  Dynamsoft.Barcode.EnumErrorCode.DBR_QR_LICENSE_INVALID = -10016, Dynamsoft.Barcode.EnumErrorCode.DBR_TIFF_READ_FAILED = -10013, Dynamsoft.Barcode.EnumErrorCode.DBR_IMAGE_READ_FAILED = -10012, Dynamsoft.Barcode.EnumErrorCode.DBR_MAX_BARCODE_NUMBER_INVALID = -10011,
  Dynamsoft.Barcode.EnumErrorCode.DBR_CUSTOM_REGION_INVALID = -10010, Dynamsoft.Barcode.EnumErrorCode.DBR_BARCODE_FORMAT_INVALID = -10009, Dynamsoft.Barcode.EnumErrorCode.DBR_INDEX_INVALID = -10008, Dynamsoft.Barcode.EnumErrorCode.DBR_BPP_NOT_SUPPORTED = -10007,
  Dynamsoft.Barcode.EnumErrorCode.DBR_FILETYPE_NOT_SUPPORTED = -10006, Dynamsoft.Barcode.EnumErrorCode.DBR_FILE_NOT_FOUND = -10005, Dynamsoft.Barcode.EnumErrorCode.DBR_LICENSE_EXPIRED = -10004, Dynamsoft.Barcode.EnumErrorCode.DBR_LICENSE_INVALID = -10003,
  Dynamsoft.Barcode.EnumErrorCode.DBR_NULL_REFERENCE = -10002, Dynamsoft.Barcode.EnumErrorCode.DBR_NO_MEMORY = -10001, Dynamsoft.Barcode.EnumErrorCode.DBR_UNKNOWN = -10000, Dynamsoft.Barcode.EnumErrorCode.DBR_SUCCESS = 0,
  Dynamsoft.Barcode.EnumErrorCode.DBR_SYSTEM_EXCEPTION = 1
}
 Describes error codes. More...
 
enum  Dynamsoft.Barcode.EnumBarcodeFormat {
  Dynamsoft.Barcode.EnumBarcodeFormat.All = 503317503, Dynamsoft.Barcode.EnumBarcodeFormat.OneD = 0x3FF, Dynamsoft.Barcode.EnumBarcodeFormat.CODE_39 = 0x1, Dynamsoft.Barcode.EnumBarcodeFormat.CODE_128 = 0x2,
  Dynamsoft.Barcode.EnumBarcodeFormat.CODE_93 = 0x4, Dynamsoft.Barcode.EnumBarcodeFormat.CODABAR = 0x8, Dynamsoft.Barcode.EnumBarcodeFormat.ITF = 0x10, Dynamsoft.Barcode.EnumBarcodeFormat.EAN_13 = 0x20,
  Dynamsoft.Barcode.EnumBarcodeFormat.EAN_8 = 0x40, Dynamsoft.Barcode.EnumBarcodeFormat.UPC_A = 0x80, Dynamsoft.Barcode.EnumBarcodeFormat.UPC_E = 0x100, Dynamsoft.Barcode.EnumBarcodeFormat.INDUSTRIAL_25 = 0x200,
  Dynamsoft.Barcode.EnumBarcodeFormat.PDF417 = 0x2000000, Dynamsoft.Barcode.EnumBarcodeFormat.QR_CODE = 0x4000000, Dynamsoft.Barcode.EnumBarcodeFormat.DATAMATRIX = 0x8000000, Dynamsoft.Barcode.EnumBarcodeFormat.AZTEC = 0x10000000
}
 Describes the type of the barcode. All the formats can be combined. More...
 
enum  Dynamsoft.Barcode.EnumConflictMode { Dynamsoft.Barcode.EnumConflictMode.ECM_Ignore = 1, Dynamsoft.Barcode.EnumConflictMode.ECM_Overwrite = 2 }
 Describes the options for setting parameters value. Detailed info can be found in PublicRuntimeSettings. More...
 
enum  Dynamsoft.Barcode.EnumImagePixelFormat {
  Dynamsoft.Barcode.EnumImagePixelFormat.IPF_Binary, Dynamsoft.Barcode.EnumImagePixelFormat.IPF_BinaryInverted, Dynamsoft.Barcode.EnumImagePixelFormat.IPF_GrayScaled, Dynamsoft.Barcode.EnumImagePixelFormat.IPF_NV21,
  Dynamsoft.Barcode.EnumImagePixelFormat.IPF_RGB_565, Dynamsoft.Barcode.EnumImagePixelFormat.IPF_RGB_555, Dynamsoft.Barcode.EnumImagePixelFormat.IPF_RGB_888, Dynamsoft.Barcode.EnumImagePixelFormat.IPF_ARGB_8888
}
 Describes the image pixel format. More...
 
enum  Dynamsoft.Barcode.EnumResultType { Dynamsoft.Barcode.EnumResultType.EDT_StandardText, Dynamsoft.Barcode.EnumResultType.EDT_RawText, Dynamsoft.Barcode.EnumResultType.EDT_CandidateText, Dynamsoft.Barcode.EnumResultType.EDT_PartialText }
 Describes the extended result type. More...
 
enum  Dynamsoft.Barcode.EnumTerminateStage { Dynamsoft.Barcode.EnumTerminateStage.ETS_Prelocalized, Dynamsoft.Barcode.EnumTerminateStage.ETS_Localized, Dynamsoft.Barcode.EnumTerminateStage.ETS_Recognized }
 Describes the stage when the results are returned. More...
 

Detailed Description

Enumeration Type Documentation

◆ EnumBarcodeFormat

Describes the type of the barcode. All the formats can be combined.

Enumerator
All 

All supported formats

OneD 

One-D

CODE_39 

Code 39

CODE_128 

Code 128

CODE_93 

Code 93

CODABAR 

Codabar

ITF 

ITF

EAN_13 

EAN-13

EAN_8 

EAN-8

UPC_A 

UPC-A

UPC_E 

UPC-E

INDUSTRIAL_25 

Industrial 2 of 5

PDF417 

PDF417

QR_CODE 

QRCode

DATAMATRIX 

DataMatrix

AZTEC 

AZTEC

◆ EnumConflictMode

Describes the options for setting parameters value. Detailed info can be found in PublicRuntimeSettings.

Enumerator
ECM_Ignore 

Ignore new settings and inherit from previous settings.

ECM_Overwrite 

overwrite and replace by new settings.

◆ EnumErrorCode

Describes error codes.

Enumerator
DBR_AZTEC_LICENSE_INVALID 

The AZTEC license is invalid.

DBR_PARAMETER_VALUE_INVALID 

The parameter value is invalid or out of range.

DBR_JSON_NAME_REFERENCE_INVALID 

The name reference is invalid.

DBR_TEMPLATE_NAME_INVALID 

The template name is invalid.

DBR_JSON_NAME_VALUE_DUPLICATED 

The value of the key "Name" is duplicated.

DBR_JSON_NAME_KEY_MISSING 

The mandatory key "Name" is missing.

DBR_JSON_VALUE_INVALID 

The value is invalid or out of range.

DBR_JSON_KEY_INVALID 

The key is invalid.

DBR_JSON_TYPE_INVALID 

The value type is invalid.

DBR_JSON_PARSE_FAILED 

Failed to parse json string.

DBR_RECOGNITION_TIMEOUT 

Recognition timeout.

DBR_CUSTOM_MODULESIZE_INVALID 

The custom module size is invalid.

DBR_CUSTOM_SIZE_INVALID 

The custom size is invalid.

DBR_PAGE_NUMBER_INVALID 

The page number is invalid.

DBR_PDF_DLL_MISSING 

The PDF DLL is missing.

DBR_PDF_READ_FAILED 

Failed to read the PDF file.

DBR_DATAMATRIX_LICENSE_INVALID 

The DATAMATRIX license is invalid.

DBR_PDF417_LICENSE_INVALID 

The PDF417 license is invalid.

DBR_DIB_BUFFER_INVALID 

The DIB(Device-independent bitmaps) buffer is invalid.

DBR_1D_LICENSE_INVALID 

The 1D barcode license is invalid.

DBR_QR_LICENSE_INVALID 

The QR Code license is invalid.

DBR_TIFF_READ_FAILED 

Failed to read the TIFF image.

DBR_IMAGE_READ_FAILED 

Failed to read the image.

DBR_MAX_BARCODE_NUMBER_INVALID 

The maximum barcode number is invalid.

DBR_CUSTOM_REGION_INVALID 

The input region value parameter is invalid.

DBR_BARCODE_FORMAT_INVALID 

The barcode format is invalid.

DBR_INDEX_INVALID 

The index is invalid.

DBR_BPP_NOT_SUPPORTED 

The BPP(Bits per pixel) is not supported.

DBR_FILETYPE_NOT_SUPPORTED 

The file type is not supported.

DBR_FILE_NOT_FOUND 

The file is not found.

DBR_LICENSE_EXPIRED 

The license has expired.

DBR_LICENSE_INVALID 

The license is invalid.

DBR_NULL_REFERENCE 

Null reference.

DBR_NO_MEMORY 

Not enough memory to perform the operation.

DBR_UNKNOWN 

Unknown error.

DBR_SUCCESS 

Successful.

DBR_SYSTEM_EXCEPTION 

System exception

◆ EnumImagePixelFormat

Describes the image pixel format.

Enumerator
IPF_Binary 

0:Black, 1:White

IPF_BinaryInverted 

0:White, 1:Black

IPF_GrayScaled 

8bit gray

IPF_NV21 

NV21

IPF_RGB_565 

16bit

IPF_RGB_555 

16bit

IPF_RGB_888 

24bit

IPF_ARGB_8888 

32bit

◆ EnumResultType

Describes the extended result type.

Enumerator
EDT_StandardText 

Specifies the standard text. This means the barcode value.

EDT_RawText 

Specifies the raw text. This means the text that includes start/stop characters, check digits, etc.

EDT_CandidateText 

Specifies all the candidate text. This means all the standard text results decoded from the barcode.

EDT_PartialText 

Specifies the partial Text. This means part of the text result decoded from the barcode.

◆ EnumTerminateStage

Describes the stage when the results are returned.

Enumerator
ETS_Prelocalized 

Prelocalized

ETS_Localized 

Localized

ETS_Recognized 

Recognized