CVB.Net 14.0
Stemmer.Cvb.Barcode Namespace Reference

Classes

class  ErrorHandling
 Error handling functionality for the CVC Barcode wrapper. More...
 
class  GradeResult1D
 Grading result for 1D codes. More...
 
class  GradeResult2DBase
 Base class for 2D grading results. More...
 
class  GradeResultBase
 Code grading result base class. More...
 
class  GradeResultDataMatrix
 DataMatrix grading results. More...
 
class  GradeResultQR
 QR grading results. More...
 
class  NamespaceDoc
 The types implemented in the namespace and assembly Stemmer.Cvb.Barcode and its sub namespaces expose the features of the CVCBarcode.dll in Cvb.Net. More...
 
class  Reader
 The actual barcode reading functionality. More...
 
class  ReaderConfig
 Barcode reader object. More...
 
class  ReadResult
 Common result components of a barcode read operation. More...
 
class  ReadResult1D
 Read Result of a 1D code. More...
 
class  ReadResult2D
 Read results for matrix codes. More...
 
class  ReadResultCode128
 Read results for Code 128. More...
 
class  ReadResultCode39Code93
 Read results for Code 39 and Code 93. More...
 
class  ReadResultDataMatrix
 Read result for DataMatrix codes. More...
 
class  ReadResultPdf417
 Read result for Pdf417 codes. More...
 
class  ReadResultQR
 Read result for QR codes. More...
 
class  ReadResultSonyCode
 Read result for Sony codes. More...
 
class  ReadResultUpcE
 Read results for UPC-E codes. More...
 
class  ResultAnalysis
 Extension functions for analyzing Barcode results. More...
 
class  SymbologyAnalysis
 Extension methods to analyze symbologies More...
 

Enumerations

enum  MsiPlesseyCheckDigit {
  None , Mod10 , Mod11 , Mod1010 ,
  Mod1011
}
 Available check digits for MSI Plessey codes. More...
 
enum  Code11CheckDigit { None , One , Two }
 Available check digits for Code11. More...
 
enum  CodeOrientation { Fence = 1 , Ladder = 2 , FenceOrLadder = 3 }
 Directions that a four state code may have. More...
 
enum  FourStateAustralianLevels {
  None = 0 , Custom = 1 , Routing = 2 , ReplyPaid = 4 ,
  Redirection = 8 , Custom2 = 16 , Custom3 = 32 , Reserved = 64 ,
  All = 32767
}
 Available level flags Four State Australian codes. More...
 
enum  FourStateLsb { Left , Bottom , Right , Top }
 LSB settings for four state codes. More...
 
enum  PlanetLevels { None = 0 , Bars62 = 1 , Bars72 = 2 , All = 32767 }
 Available level flags for Planet codes. More...
 
enum  PostnetLevels {
  None = 0 , Bars32 = 1 , Bars37 = 2 , Bars47 = 4 ,
  Bars52 = 8 , Bars62 = 16 , All = 32767
}
 Available level flags for Postnet codes. More...
 
enum  PharmaCodeRunDirection { Right , Up , Left , Down }
 Run direction of Pharma Codes. More...
 
enum  PharmaCodeTolerance { Standard , Extended }
 Tolerance levels for Pharma Code reading acceptance checks. More...
 
enum  DataMatrixLevels {
  Ecc0 = 1 , Ecc50 = 2 , Ecc80 = 4 , Ecc100 = 8 ,
  Ecc140 = 16 , Ecc200 = 32 , All = 32767
}
 Levels of DataMatrix codes to recognize. Different levels may be combined using '|'. More...
 
enum  DataMatrixFormats {
  Base11 = 1 , Base27 = 2 , Base37 = 4 , Base41 = 8 ,
  Ascii = 16 , Binary = 32 , All = 32767
}
 Formats of DataMatrix codes to recognize. Different formats may be combined using '|'. More...
 
enum  DataMatrixSubType { DataMatrix , PharmaCode2D , DottedDatamatrix }
 Sub types of data matrix codes to read. More...
 
enum  PharmaCodeSkew {
  StrongRight = -2 , ModerateRight = -1 , None = 0 , ModerateLeft = 1 ,
  StrongLeft = 2
}
 Skew of the Pharma Code bars. More...
 
enum  PharmaCode2DDisposition { DontCare , Present , Miss }
 Expectation setting for Pharma Code 2D elements. More...
 
enum  Pdf417Levels {
  Level0 = 1 , Level1 = 2 , Level2 = 4 , Level3 = 8 ,
  Level4 = 16 , Level5 = 32 , Level6 = 64 , Level7 = 128 ,
  Level8 = 256 , All = 32767
}
 Available PDF417 levels. More...
 
enum  QRSubType { Mini , Standard , Both }
 QR code types to read. More...
 
enum  RssTypes {
  Rss14 = 1 , Rss14Truncated = 2 , Rss14Stacked = 4 , Rss14StackedOmnidirectional = 8 ,
  Limited = 16 , Expanded = 32 , ExpandedStacked = 64 , All = 32767
}
 Types of RSS codes to read. More...
 
enum  RssComposition {
  Off = 0 , None = 1 , CCA = 2 , CCB = 4 ,
  All = 32767
}
 Composition flags for RSS codes. More...
 
enum  DecodeResult {
  Success , NothingFound , SymbologyOnly , WrongCodeSize ,
  WrongCodeFormat , ErrorDetectionFailed , ColorNotCorrect , QuietzoneViolation = short.MaxValue - 1 ,
  Error
}
 Possible barcode reading results. More...
 
enum  ReaderInitialization { ReadNone , ReadAll }
 Possible ways to initialize a Barcode reader. More...
 
enum  Symbology {
  None = 0 , Code128 = 1 , Codabar = 2 , Ean13 = 3 ,
  Ean8 = 4 , UpcA = 5 , UpcE = 6 , Pdf417 = 7 ,
  DataMatrix = 8 , Code39 = 9 , Code93 = 10 , Discrete2of5 = 11 ,
  Interleaved2of5 = 12 , Code32 = 13 , PharmaCode = 14 , PharmaCode2D = 15 ,
  SonyCode = 16 , RSS = 17 , FourStateKix = 19 , Postnet = 21 ,
  Planet = 22 , QR = 23 , FourStateRoyalMail = 24 , FourStateAustralian = 25 ,
  FourStateUsps = 26 , MicroPdf417 = 29 , MsiPlessey = 30 , Code11 = 31 ,
  BarcodeGrading = 256 , DataMatrixGrading = 257 , QRGrading = 258
}
 The symbologies supported by Barcode. More...
 
enum  Readout {
  Omnidirectional , Fence , Ladder , FenceOrLadder ,
  SmallCodes
}
 Available readout modes. More...
 
enum  EccLevelQR {
  NotDecodable , None , L , M ,
  Q , H
}
 ECC levels as used by QR codes. More...
 
enum  Code128SubType { Ean128 , Code128 }
 Possible sub types of Code128. More...
 
enum  QRMasking {
  Unknown , Mode000 , Mode001 , Mode010 ,
  Mode011 , Mode100 , Mode101 , Mode110 ,
  Mode111
}
 Masking modes of QR codes. More...
 
enum  GradeResult1DInfo {
  Ok = 0 , NoResult = 1 , CodePositionOutsideAoi = 2 , CodeHeightTooSmall = 3 ,
  CodeNotRectangular = 4 , GradingNotSupported = 5 , Timeout = 6 , CodeTypeNotSupported = -1 ,
  TooManyCharacters = -2 , MeasuringOrificeNotSupported = -3 , AoiTooSmall = -4 , DecodabilityCheckFailed = -5 ,
  PixelOutsideAoi = -6 , BoundaryCheckFailed = -7 , TrimmingToParallelFailed = -8 , ErrNoMaxFailed = -9 ,
  ECMinFailed = -10
}
 Additional information about 1D grading results. More...
 

Enumeration Type Documentation

◆ Code11CheckDigit

Available check digits for Code11.

Enumerator
None 

no check digit

One 

check digit 1

Two 

check digit 2

◆ Code128SubType

Possible sub types of Code128.

Enumerator
Ean128 

EAN 128 sub type.

Code128 

Code 128 sub type.

◆ CodeOrientation

Directions that a four state code may have.

Enumerator
Fence 

Bars are aligned vertically.

Ladder 

Bars are aligned horizontally.

FenceOrLadder 

Bars may be aligned vertically or horizontally.

◆ DataMatrixFormats

Formats of DataMatrix codes to recognize. Different formats may be combined using '|'.

Enumerator
Base11 

Base 11 Data Matrix format.

Base27 

Base 27 Data Matrix format.

Base37 

Base 37 Data Matrix format.

Base41 

Base 41 Data Matrix format.

Ascii 

ASCII Data Matrix format.

Binary 

Binary Data Matrix format.

All 

All Data Matrix formats.

◆ DataMatrixLevels

Levels of DataMatrix codes to recognize. Different levels may be combined using '|'.

Enumerator
Ecc0 

ECC level 0.

Ecc50 

ECC level 50.

Ecc80 

ECC level 80.

Ecc100 

ECC level 100.

Ecc140 

ECC level 140.

Ecc200 

ECC level

All 

All available ECC levels.

◆ DataMatrixSubType

Sub types of data matrix codes to read.

Enumerator
DataMatrix 

Regular printed data matrix code.

PharmaCode2D 

2D Pharma code

DottedDatamatrix 

Direct Part Marking Data Matrix ('dotted' data matrix)

◆ DecodeResult

Possible barcode reading results.

Enumerator
Success 

Code was successfully read.

NothingFound 

No code was found in the area of interest.

SymbologyOnly 

A code symbology was detected in the area of interest but reading the code failed.

WrongCodeSize 

A code symbology was detected and decoded, but the code had an unexpected size that violates the limits of the symbology.

WrongCodeFormat 

A code symbology was detected and decoded, but the code turned out to have the wrong format.

ErrorDetectionFailed 

A code symbology was detected and decoded, but the error detection checks failed.

ColorNotCorrect 

A 2D Pharmacode uses and invalid color bar.

QuietzoneViolation 

A code symbology was detected and decoded but the code violates the quiet zone requirements.

Error 

An unspecified error occurred during code reading.

◆ EccLevelQR

enum EccLevelQR

ECC levels as used by QR codes.

Enumerator
NotDecodable 

The ECC level was not decodeable.

None 

No ECC information found.

ECC level L detected.

ECC level M detected.

ECC level Q detected.

ECC level H detected.

◆ FourStateAustralianLevels

Available level flags Four State Australian codes.

Enumerator
None 

No level information.

Custom 

Custom info.

Routing 

Routing.

ReplyPaid 

Reply paid.

Redirection 

Redirected.

Custom2 

Custom 2 info.

Custom3 

Custom 3 info.

Reserved 

Reserved.

All 

All levels.

◆ FourStateLsb

LSB settings for four state codes.

Enumerator
Left 

Left.

Bottom 

Bottom.

Right 

Right.

Top 

Top.

◆ GradeResult1DInfo

Additional information about 1D grading results.

Enumerator
Ok 

Grading was successful and did yield a result.

NoResult 

Barcode could not be decoded, therefore no grading was calculated.

CodePositionOutsideAoi 

The Barcode is partly outside the AOI.

CodeHeightTooSmall 

The Barcode's height is too small for grading.

CodeNotRectangular 

The Barcode does not have a rectangular shape, making it unsuitable for grading.

GradingNotSupported 

Barcode grading is not supported for the encountered symbology.

Timeout 

Time limit reached during grading.

CodeTypeNotSupported 

An unsupported code type was encountered.

TooManyCharacters 

The code contained more characters than permitted for its symbology.

MeasuringOrificeNotSupported 

Orifice measurement is currently not supported.

AoiTooSmall 

The area of interest specified is too small to contain a valid code.

DecodabilityCheckFailed 

A code was found but considered to be undecodable.

PixelOutsideAoi 

Some pixels of the code are outside the specified area of interest.

BoundaryCheckFailed 

A boundary check failed.

TrimmingToParallelFailed 

Trimming failed.

ErrNoMaxFailed 

?

ECMinFailed 

?

◆ MsiPlesseyCheckDigit

Available check digits for MSI Plessey codes.

Enumerator
None 

None

Mod10 

Mod10

Mod11 

Mod11

Mod1010 

Mod10 10

Mod1011 

Mod10 11

◆ Pdf417Levels

Available PDF417 levels.

Enumerator
Level0 

Level 0.

Level1 

Level 1.

Level2 

Level 2.

Level3 

Level 3.

Level4 

Level 4.

Level5 

Level 5.

Level6 

Level 6.

Level7 

Level 7.

Level8 

Level 8.

All 

All available levels.

◆ PharmaCode2DDisposition

Expectation setting for Pharma Code 2D elements.

Enumerator
DontCare 

It won't matter whether or not the element is present.

Present 

The element should be present.

Miss 

The element should not be present.

◆ PharmaCodeRunDirection

Run direction of Pharma Codes.

Enumerator
Right 

Code runs from left to right.

Up 

Code runs vertically up.

Left 

Code runs from right to left.

Down 

Code runs vertically down.

◆ PharmaCodeSkew

Skew of the Pharma Code bars.

Enumerator
StrongRight 

Strongly skewed to the right.

ModerateRight 

Moderately skewed to the right.

None 

Not skewed.

ModerateLeft 

Moderately skewed to the left.

StrongLeft 

Strongly skewed to the left.

◆ PharmaCodeTolerance

Tolerance levels for Pharma Code reading acceptance checks.

Enumerator
Standard 

Standard tolerance level.

Extended 

Extended (= more relaxed) tolerance level.

◆ PlanetLevels

Available level flags for Planet codes.

Enumerator
None 

None.

Bars62 

62 bars.

Bars72 

72 bars.

All 

All available levels.

◆ PostnetLevels

Available level flags for Postnet codes.

Enumerator
None 

None.

Bars32 

32 bars.

Bars37 

37 bars.

Bars47 

47 bars.

Bars52 

52 bars.

Bars62 

62 bars.

All 

All available levels.

◆ QRMasking

enum QRMasking

Masking modes of QR codes.

Enumerator
Unknown 

Unknown mask mode.

Mode000 

Mask mode 000.

Mode001 

Mask mode 001.

Mode010 

Mask mode 010.

Mode011 

Mask mode 011.

Mode100 

Mask mode 100.

Mode101 

Mask mode 101.

Mode110 

Mask mode 110.

Mode111 

Mask mode 111.

◆ QRSubType

enum QRSubType

QR code types to read.

Enumerator
Mini 

Mini QR codes only.

Standard 

Standard QR codes only.

Both 

Both types of QR codes.

◆ ReaderInitialization

Possible ways to initialize a Barcode reader.

Enumerator
ReadNone 

Initialize the reader to read no code.

ReadAll 

Initialize the reader to read all codes.

◆ Readout

enum Readout

Available readout modes.

Enumerator
Omnidirectional 

Read a barcode no matter what the orientation of the bars is.

Fence 

Read a barcode only if the bars are oriented vertically.

Ladder 

Read a barcode only if the bars are oriented horizontally.

FenceOrLadder 

Read a barcode if the bars are either oriented vertically or horizontally.

SmallCodes 

Expect the barcodes to be very small.

◆ RssComposition

Composition flags for RSS codes.

Enumerator
Off 

Composition off.

None 

No composition.

CCA 

CCA composition.

CCB 

CCB composition.

All 

All available compositions.

◆ RssTypes

enum RssTypes

Types of RSS codes to read.

Enumerator
Rss14 

RSS 14.

Rss14Truncated 

Truncated RSS 14.

Rss14Stacked 

Stacked RSS 14.

Rss14StackedOmnidirectional 

Stacked RSS 14 (omni directional reading).

Limited 

RSS Limited.

Expanded 

RSS Expanded.

ExpandedStacked 

RSS Expanded Stacked.

All 

All available types.

◆ Symbology

enum Symbology

The symbologies supported by Barcode.

Enumerator
None 

No symbology (e.g. if reading failed).

Code128 

Code 128 Barcode

Codabar 

Codabar Barcode

Ean13 

EAN 13 Barcode

Ean8 

EAN 8 Barcode

UpcA 

UPC-A Barcode

UpcE 

UPC-E Barcode

Pdf417 

PDF417 Matrix Code

DataMatrix 

Data Matrix Code

Code39 

Code 39 Barcode

Code93 

Code 93 Barcode

Discrete2of5 

2 of 5 Discrete Barcode

Interleaved2of5 

2 of 5 Interleaved Barcode

Code32 

Code 32 Barcode

PharmaCode 

PharmaCode Barcode

PharmaCode2D 

PharmaCode Matrix Code

SonyCode 

SonyCode Barcode

RSS 

RSS Barcode

FourStateKix 

Four State KIX Barcode

Postnet 

Postnet Barcode

Planet 

Planet Barcode

QR 

QR Matrix Code

FourStateRoyalMail 

Four State Royal Mail Barcode

FourStateAustralian 

Four State Australian Barcode

FourStateUsps 

Four State USPS Barcode

MicroPdf417 

Micro PDF417 Matrix Code

MsiPlessey 

MSI Plessey Barcode

Code11 

Code 11 Barcode

BarcodeGrading 

1D Barcode grading

DataMatrixGrading 

DataMatrix grading

QRGrading 

QR code grading