Get Pricing Download 30-Day Trial
Dev Center
Table of contents

C++ Language API Reference

CBarcodeReader class

Constructor and Destructor

Method Description
CBarcodeReader Default constructor of CBarcodeReader object.
~CBarcodeReader Destructor of CBarcodeReader object.
GetInstance Gets an idle Dynamsoft Barcode Reader instance running on concurrent instance mode.
Recycle Recycles a Dynamsoft Barcode Reader instance running on concurrent instance mode.

License Methods

Method Description
InitLicense Initializes license key and activate the SDK.
GetDeviceUUID Gets the device uuid used for license activating.
IsInstanceValid Gets whether the instance is valid when charging by concurrent instances count.
SetDeviceFriendlyName Sets a human-readable name that identifies the device.
SetLicenseCachePath Sets a directory path for saving the license cache.
SetMaxConcurrentInstanceCount Sets the max concurrent instance count used for current device and process.
GetIdleInstancesCount Deprecated
InitLicenseFromServer Deprecated
InitLicenseFromLicenseContent Deprecated
OutputLicenseToString Deprecated
OutputLicenseToStringPtr Deprecated
FreeLicenseString Deprecated
InitDLSConnectionParameters Deprecated
InitLicenseFromDLS Deprecated
InitLTSConnectionParameters Deprecated
InitLicenseFromLTS Deprecated

Decode Methods

Method Description
DecodeFile Decode barcodes from a specified image file.
DecodeFileInMemory Decode barcodes from an image file in memory.
DecodeBuffer Decode barcodes from raw buffer.
DecodeBase64String Decode barcodes from a base64 encoded string.
DecodeDIB Decode barcode from a handle of device-independent bitmap (DIB).
InitIntermediateResult Inits an intermediateResult struct with default values.
DecodeIntermediateResults Decodes barcode from intermediate results.

Basic Settings Methods

Method Description
SetModeArgument Set argument value for the specified mode parameter.
GetModeArgument Get argument value for the specified mode parameter.
GetRuntimeSettings Get current runtime settings.
UpdateRuntimeSettings Modify and update the current runtime settings.
ResetRuntimeSettings Reset runtime settings to default.

Advanced Settings Methods

Method Description
InitRuntimeSettingsWithFile Initialize runtime settings with the settings in a given JSON file.
InitRuntimeSettingsWithString Initialize runtime settings with the settings in a given JSON string.
AppendTplFileToRuntimeSettings Append a new template file to the current runtime settings.
AppendTplStringToRuntimeSettings Append a new template string to the current runtime settings.
GetParameterTemplateCount Get the count of the parameter templates.
GetParameterTemplateName Get the parameter template name by index.
OutputSettingsToFile Output runtime settings to a settings file (JSON file).
OutputSettingsToString Output runtime settings to a string.
OutputSettingsToStringPtr Output runtime settings to a string.
FreeSettingsString Free memory allocated for runtime settings string.

Result Methods

Method Description
GetAllTextResults Get all recognized barcode results.
FreeTextResults Free memory allocated for text results.
GetIntermediateResults Get intermediate results.
FreeIntermediateResults Free memory allocated for the intermediate results.

General Methods

Method Description
GetErrorString Get error message by error code.
GetVersion Get version information of SDK.
TransformCoordinates Transform the coordinates of a point based on the given transformation matrix.
FreeString Free memory allocated for string.

Video Methods

Decode

Method Description
StartFrameDecoding Decode barcodes from inner frame queue.
StartFrameDecodingEx Decode barcodes from inner frame queue.
AppendFrame Append a frame image buffer to the inner frame queue.
StopFrameDecoding Stop thread used for frame decoding.

Parameter

Method Description
InitFrameDecodingParameters Initialize frame decoding parameter.

Callback

Method Description
SetErrorCallback Set callback function to process errors which is triggered when the library finishes decoding a frame.
SetTextResultCallback Set callback function to process text results which is triggered when the library finishes decoding a frame.
SetUniqueBarcodeCallback Set callback function to process text results which is triggered when the library finishes decoding a frame and finds unique barcodes.
SetIntermediateResultCallback Set callback function to process intermediate results which is triggered when the library finishes decoding a frame.

Status retrieval

Method Description
GetLengthOfFrameQueue Get length of current inner frame queue.

Structs

Struct Description
AztecDetails Stores the Aztec details.
Contour Stores the contour information.
DBRPoint Stores an x- and y-coordinate pair in two-dimensional space.
DataMatrixDetails Stores the DataMatrix details.
DM_DLSConnectionParameters Deprecated
DM_LTSConnectionParameters Deprecated
ExtendedResult Stores the extended result.
FrameDecodingParameters Defines a struct to configure the frame decoding Parameters.
FurtherModes Stores the FurtherModes.
ImageData Stores the image data.
IntermediateResult Stores the intermediate result.
IntermediateResultArray Stores the intermediate result array.
LineSegment Stores line segment data.
LocalizationResult Stores the localization result.
OneDCodeDetails Stores the OneD code details.
PDF417Details Stores the PDF417 details.
PublicRuntimeSettings Defines a struct to configure the barcode reading runtime settings.
QRCodeDetails Stores the QRCode details.
Quadrilateral Stores the quadrilateral.
RegionDefinition Stores the region information.
RegionOfInterest Stores the region of interest.
SamplingImageData Stores the sampling image data.
TextResult Stores the text result.
TextResultArray Stores the text result array.

Enumerations

Format Enumeration

Enumeration Description
BarcodeFormat Describes the barcode types in BarcodeFormat group 1.
BarcodeFormat_2 Describes the barcode types in BarcodeFormat group 2.

Parameter Mode Enumeration

Enumeration Description
BarcodeColourMode Describes the barcode colour mode.
BarcodeComplementMode Describes the barcode complement mode.
BinarizationMode Describes the binarization mode.
ColourClusteringMode Describes the colour clustering mode.
ColourConversionMode Describes the colour conversion mode.
ConflictMode Describes the conflict mode.
DeblurMode Describes the deblur mode.
DeformationResistingMode Describes the deformation resisting mode.
DPMCodeReadingMode Describes the DPM code reading mode.
GrayscaleTransformationMode Describes the grayscale transformation mode.
ImagePreprocessingMode Describes the image preprocessing mode.
LocalizationMode Describes the localization mode.
PDFReadingMode Describes the PDF reading mode.
RegionPredetectionMode Describes the region predetection mode.
ScaleUpMode Describes the scale up mode.
TerminatePhase Describes the terminate phase.
TextFilterMode Describes the text filter mode.
TextureDetectionMode Describes the texture detection mode.
Enumeration Description
IMResultDataType Describes the intermediate result data type.
IntermediateResultSavingMode Describes the intermediate result saving mode.
IntermediateResultType Describes the intermediate result type.
ResultCoordinateType Describes the result coordinate type.
ResultType Describes the extended result type.
TextResultOrderMode Describes the text result order mode.

Frame Decoding Enumeration

Enumeration Description
ClarityCalculationMethod Describes the clarity calculation method.
ClarityFilterMode Describes the clarity filter mode.

Other Enumeration

Enumeration Description
DM_ChargeWay Deprecated
DM_DeploymentType Deprecated
DM_LicenseModule Deprecated
DM_UUIDGenerationMethod Deprecated
ImagePixelFormat Describes the image pixel format.
QRCodeErrorCorrectionLevel Describes the QR Code error correction level.
Product Deprecated

Error Code

Callbacks

Method Description
CB_Error Represents the method that will handle the error code returned by the SDK.
CB_IntermediateResult Represents the method that will handle the intermediate result array returned by the SDK.
CB_TextResult Represents the method that will handle the text result array returned by the SDK.

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article:

version 9.6.20

  • Latest version
  • Version 10.x
    • Version 10.4.2000
    • Version 10.4.10
    • Version 10.2.10
    • Version 10.2.0
    • Version 10.0.20
    • Version 10.0.10
    • Version 10.0.0
  • Version 9.x
    • Version 9.6.40
    • Version 9.6.30
    • Version 9.6.20
    • Version 9.6.10
    • Version 9.6.0
    • Version 9.4.0
    • Version 9.2.0
    • Version 9.0.0
  • Version 8.x
    • Version 8.8.0
    • Version 8.6.0
    • Version 8.4.0
    • Version 8.2.0
    • Version 8.1.2
    • Version 8.1.0
    • Version 8.0.0
  • Version 7.x
    • Version 7.6.0
    • Version 7.5.0
  • Documentation Homepage
Change +