Web Demos

BARCODE READER SDK DEMO

Explore the flexibe barcode reading settings to optimize for your specific usage scenario.

WEB TWAIN SDK DEMO

Try the most popular web scanner features: scan images, import local images and PDF files, edit, save to local, upload to database, and etc.

BARCODE READER JAVASCRIPT DEMO

Transform any camera-equipped devices into real-time, browser-based barcode and QR code scanners.

MRZ SCANNER WEB DEMO

Detects the machine-readable zone of a passport, scans the text, and parses into human-readable data.

APP STORE DEMOS

BARCODE READER SDK FOR IOS

BARCODE READER SDK FOR ANDROID

VIEW MORE DEMOS >
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.

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.
GetInstancePoolStatus Gets a class to represent the status of an instance pool.
GetIdleInstancesCount Deprecated
InitLicenseFromServer Deprecated
InitLicenseFromLicenseContent Deprecated
OutputLicenseToString Deprecated
InitDLSConnectionParameters Deprecated
InitLicenseFromDLS Deprecated
InitLTSConnectionParameters Deprecated
InitLicenseFromLTS Deprecated

InitLicense

Initializes license key and activate the SDK.

static EnumErrorCode Dynamsoft.DBR.BarcodeReader.InitLicense (string license, out string errorMsg)

Parameters
[in] licenseKey <string> : The license key of Barcode Reader.
[out] errorMsg <string> : The detailed error message.

Return Value
Returns error code (returns DBR_SUCCESS if the function operates successfully).
You can check errorMsg to get detailed error message.

Code Snippet

string errorMsg;
BarcodeReader.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
BarcodeReader reader = BarcodeReader.GetInstance();
if (reader != null)
{
	// add further process
    reader.Recycle();
}

GetDeviceUUID

Gets the device uuid used for license activating.

static string Dynamsoft.DBR.BarcodeReader.GetDeviceUUID(EnumDMUUIDGenerationMethod uuidGenerationMethod)

Parameters

[in] uuidGenerationMethod The method used to generate the UUID.

Return Value

Returns the result UUID.

IsInstanceValid

Gets whether the instance is valid when charging by concurrent instances count.

int Dynamsoft.DBR.BarcodeReader.IsInstanceValid()

Return Value

Returns an int value indicating whether the instance is valid for running on concurrent instance mode.

  • 0: The instance is not valid for running on concurrent instance mode.
  • 1: The instance is valid for running on concurrent instance mode.

Remarks

This method is meaningful only when using a license charged by concurrent instances count.

SetDeviceFriendlyName

Sets a human-readable name that identifies the device.

static EnumErrorCode Dynamsoft.DBR.BarcodeReader.SetDeviceFriendlyName(string name)

Parameters

[in] name The device alias.

Return Value

Returns error code (returns DBR_SUCCESS if the function operates successfully).

Code Snippet

string errorMsg;
BarcodeReader.SetDeviceFriendlyName("My-PC");
BarcodeReader.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
BarcodeReader reader = BarcodeReader.GetInstance();
if (reader != null)
{
	// add further process
    reader.Recycle();
}

SetLicenseCachePath

Sets a directory path for saving the license cache.

static EnumErrorCode Dynamsoft.DBR.BarcodeReader.SetLicenseCachePath(string directoryPath)

Parameters

[in] directoryPath The directory path where to save the license cache.

Return Value

Returns error code.

Code Snippet

string errorMsg;
BarcodeReader.SetLicenseCachePath("DIRECTORY-PATH-FOR-LICENSE-CACHE");
BarcodeReader.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
BarcodeReader reader = BarcodeReader.GetInstance();
if (reader != null)
{
	// add further process
    reader.Recycle();
}

SetMaxConcurrentInstanceCount

Sets the max concurrent instance count used for current device and process.

static void Dynamsoft.DBR.BarcodeReader.SetMaxConcurrentInstanceCount(int countForThisDevice, int countForThisProcess)
static void Dynamsoft.DBR.BarcodeReader.SetMaxConcurrentInstanceCount(int countForThisDevice, int countForThisProcess, int timeout)

Parameters

[in] countForThisDevice The maximum number of concurrent instances that the current device can run.

[in] countForThisProcess The maximum number of concurrent instances that the current process can run.

[in] timeout The maximum time (in milliseconds) to wait for an available authorization or instance when calling InitLicense, GetInstance, or Decode functions.

Code Snippet

string errorMsg;
int countForThisDevice = 1; // The count value should be set based on your purchased license count
int countForThisProcess = 1; // The count value should be set based on your purchased license count
BarcodeReader.SetMaxConcurrentInstanceCount(countForThisDevice, countForThisProcess);
BarcodeReader.InitLicense("YOUR-LICENSE-KEY", out errorMsg);
BarcodeReader reader = BarcodeReader.GetInstance();
// If no instance is available right away, the application will wait until one becomes available
if (reader != null)
{
    // Add your code here to call decoding method, process barcode results and so on
    // ...
    // Recycle the instance to make it idle for other concurrent tasks
    reader.Recycle();
}

GetInstancePoolStatus

Gets a class to represent the status of an instance pool.

static InstancePoolStatus Dynamsoft.DBR.BarcodeReader.GetInstancePoolStatus()

Return Value

Returns the InstancePoolStatus class representing the status of an instance pool.

GetIdleInstancesCount

Deprecated. It still works in this version but could be removed in the near future.

static int Dynamsoft.DBR.BarcodeReader.GetIdleInstancesCount()

InitLicenseFromServer

Deprecated. It still works in this version but could be removed in the near future.

int Dynamsoft.DBR.BarcodeReader.InitLicenseFromServer(string licenseServer, string licenseKey)

InitLicenseFromLicenseContent

Deprecated. It still works in this version but could be removed in the near future.

int Dynamsoft.DBR.BarcodeReader.InitLicenseFromLicenseContent(string licenseKey, string strLicenseContent)

OutputLicenseToString

Deprecated. It still works in this version but could be removed in the near future.

string Dynamsoft.DBR.BarcodeReader.OutputLicenseToString()

InitDLSConnectionParameters

Deprecated. It still works in this version but could be removed in the near future.

static DMDLSConnectionParameters Dynamsoft.DBR.BarcodeReader.InitDLSConnectionParameters()

InitLicenseFromDLS

Deprecated. It still works in this version but could be removed in the near future.

static EnumErrorCode Dynamsoft.DBR.BarcodeReader.InitLicenseFromDLS(DMDLSConnectionParameters dlsConnectionParameters, out string errorMsg)

InitLTSConnectionParameters

Deprecated. It still works in this version but could be removed in the near future.

InitLicenseFromLTS

Deprecated. It still works in this version but could be removed in the near future.

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

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