Dev Center
Table of contents

Dynamsoft Barcode Reader SDK - C++ API Reference

CBarcodeReader Methods

Constructor and Destructor

Method Description
CBarcodeReader Default constructor of CBarcodeReader object.
~CBarcodeReader Destructor of CBarcodeReader object.

Decode

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).

Parameter and Runtime Settings

Basic

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

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.

License

Method Description
InitLicense Read product key and activate the SDK.
InitLicenseFromServer Initialize license and connect to the specified server for online verification.
InitLicenseFromLicenseContent Initialize license from the license content on client machine for offline verification.
OutputLicenseToString Output the license content to a string from the license server.
OutputLicenseToStringPtr Output the license content to a string from the license server.
FreeLicenseString Free memory allocated for the license string.

Result

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

Method Description
GetErrorString Get error message by error code.
GetVersion Get version information of SDK.

Video

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.
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.

CBarcodeReader Protected Attribute

Attribute Description
m_pBarcodeReader  

Function Pointer

Function 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.

Error Code

Structs

Enumerations

This page is compatible for:

Is this page helpful?

YesYes NoNo

version 7.6.0

  • 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 +