Dev Center
Table of contents

Thanks for downloading Dynamsoft Barcode Reader Package!

Your download will start shortly. If your download does not begin, click here to retry.

Dynamsoft Barcode Reader SDK - C API Reference

Methods

Initialize and Destroy

Method Description
DBR_CreateInstance Create an instance of Dynamsoft Barcode Reader.
DBR_DestroyInstance Destroy the instance of Dynamsoft Barcode Reader.

Decode

Method Description
DBR_DecodeFile Decode barcodes from a specified image file.
DBR_DecodeFileInMemory Decode barcodes from an image file in memory.
DBR_DecodeBuffer Decode barcodes from raw buffer.
DBR_DecodeBase64String Decode barcodes from a base64 encoded string.
DBR_DecodeDIB Decode barcode from a handle of device-independent bitmap (DIB).
DBR_InitIntermediateResult Inits an intermediateResult struct with default values.
DBR_DecodeIntermediateResults Decodes barcode from intermediate results.

Parameter and Runtime Settings

Basic

Method Description
DBR_SetModeArgument Set argument value for the specified mode parameter.
DBR_GetModeArgument Get argument value for the specified mode parameter.
DBR_GetRuntimeSettings Get current runtime settings.
DBR_UpdateRuntimeSettings Modify and update the current runtime settings.
DBR_ResetRuntimeSettings Reset runtime settings to default.

Advanced

Method Description
DBR_InitRuntimeSettingsWithFile Initialize runtime settings with the settings in a given JSON file.
DBR_InitRuntimeSettingsWithString Initialize runtime settings with the settings in a given JSON string.
DBR_AppendTplFileToRuntimeSettings Append a new template file to the current runtime settings.
DBR_AppendTplStringToRuntimeSettings Append a new template string to the current runtime settings.
DBR_GetParameterTemplateCount Get the count of the parameter templates.
DBR_GetParameterTemplateName Get the parameter template name by index.
DBR_OutputSettingsToFile Output runtime settings to a settings file (JSON file).
DBR_OutputSettingsToString Output runtime settings to a string.
DBR_OutputSettingsToStringPtr Output runtime settings to a string.
DBR_FreeSettingsString Free memory allocated for runtime settings string.

License

Method Description
DBR_InitLicense Read product key and activate the SDK.
DBR_InitLicenseFromServer Initialize license and connect to the specified server for online verification.
DBR_InitLicenseFromLicenseContent Initialize license from the license content on client machine for offline verification.
DBR_OutputLicenseToString Output the license content to a string from the license server.
DBR_OutputLicenseToStringPtr Output the license content to a string from the license server.
DBR_FreeLicenseString Free memory allocated for the license string.
DBR_InitLTSConnectionParameters Initializes a DM_LTSConnectionParameters struct with default values.
DBR_InitLicenseFromLTS Initializes the barcode reader license and connects to the specified server for online verification.

Result

Method Description
DBR_GetAllTextResults Get all recognized barcode results.
DBR_FreeTextResults Free memory allocated for text results.
DBR_GetIntermediateResults Get intermediate results.
DBR_FreeIntermediateResults Free memory allocated for the intermediate results.

General

Method Description
DBR_GetErrorString Get error message by error code.
DBR_GetVersion Get version information of SDK.

Video

Decode

Method Description
DBR_StartFrameDecoding Decode barcodes from inner frame queue.
DBR_StartFrameDecodingEx Decode barcodes from inner frame queue.
DBR_AppendFrame Append a frame image buffer to the inner frame queue.
DBR_StopFrameDecoding Stop thread used for frame decoding.

Parameter

Method Description
DBR_InitFrameDecodingParameters Initialize frame decoding parameter.

Callback

Method Description
DBR_SetErrorCallback Set callback function to process errors which is triggered when the library finishes decoding a frame.
DBR_SetTextResultCallback Set callback function to process text results which is triggered when the library finishes decoding a frame.
DBR_SetIntermediateResultCallback Set callback function to process intermediate results which is triggered when the library finishes decoding a frame.

Status retrieval

Method Description
DBR_GetLengthOfFrameQueue Get length of current inner frame queue.

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:

Version 7.5.0

Is this page helpful?

YesYes NoNo

version 8.2.0

  • Latest version
  • Version 10.x
    • Version 10.0.20
    • Version 10.0.10
    • Version 10.0.0
  • Version 9.x
    • 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
Change +