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

Dynamsoft Barcode Reader SDK - .Net API Reference

BarcodeReader Methods

Constructor and Destructor

Method Description
BarcodeReader Constructor of BarcodeReader object.
Dispose Destroys an instance of Dynamsoft Barcode Reader.

Decode

Method Description
DecodeFile Decodes barcodes from a specified image file.
DecodeFileInMemory Decode barcodes from an image file in memory.
DecodeBuffer Decodes barcodes from the memory buffer containing image pixels in defined format.
DecodeBase64String Decodes barcodes from a base64 encoded string.
DecodeBitmap Decodes barcode from a bitmap.

Parameter and Runtime Settings

Basic

Method Description
SetModeArgument Sets the optional argument for a specified mode in Modes parameters.
GetModeArgument Gets the optional argument for a specified mode in Modes parameters.
GetRuntimeSettings Gets current runtime settings.
UpdateRuntimeSettings Update runtime settings with a given struct.
ResetRuntimeSettings Resets all parameters to default values.

Advanced

Method Description
InitRuntimeSettingsWithFile Initializes runtime settings with the settings in a given JSON file.
InitRuntimeSettingsWithString Initializes runtime settings with the settings in a given JSON string.
AppendTplFileToRuntimeSettings Appends a new template file to the current runtime settings.
AppendTplStringToRuntimeSettings Appends a new template string to the current runtime settings.
GetAllParameterTemplateNames Gets the parameter templates name array.
OutputSettingsToFile Outputs runtime settings to a settings file (JSON file).
OutputSettingsToString Outputs runtime settings to a string.

License

Method Description
InitLicenseFromServer Initializes license and connect to the specified server for online verification.
InitLicenseFromLicenseContent Initializes license from the license content on client machine for offline verification.
OutputLicenseToString Outputs the license content as an encrypted string from the license server to be used for offline license verification.

General

Method Description
GetVersion Gets version information of SDK.

Video

Decode

Method Description
StartFrameDecoding Starts a new thread to decode barcodes from the inner frame queue.
StartFrameDecodingEx Starts a new thread to decode barcodes from the inner frame queue.
AppendFrame Appends a frame image buffer to the inner frame queue.
StopFrameDecoding Stops the frame decoding thread created by StartFrameDecoding.

Parameter

Method Description
InitFrameDecodingParameters Initializes frame decoding parameters.

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 Gets length of current inner frame queue.

Result

Method Description
GetIntermediateResults Returns intermediate results containing the original image, the colour clustered image, the binarized Image, contours, Lines, TextBlocks, etc.

BarcodeReader Attributes

Attribute Description
ProductKeys Product keys used for Dynamsoft Barcode Reader.

Function Pointers

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

Classes

Enumerations

This page is compatible for:

Is this page helpful?

YesYes NoNo

version 7.6.0

  • Latest version
  • Version 10.x
    • 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 +