Dev Center
Table of contents

License Methods

Method Description
InitLicenseFromServer Initializes license and connect to the specified server for online verification.
InitLicenseFromLicenseContent Initializes barcode reader license and connects to the specified server for online verification.
OutputLicenseToString Outputs the license content as an encrypted string from the license server to be used for offline license verification.
InitDLSConnectionParameters Initializes a DMDLSConnectionParameters struct with default values.
InitLicenseFromDLS Initializes the barcode reader license and connects to the specified server for online verification.
GetIdleInstancesCount Gets available instances count when charging by concurrent instances count.
InitLTSConnectionParameters Deprecated. Use InitDLSConnectionParameters instead.
InitLicenseFromLTS Deprecated. Use InitLicenseFromDLS instead.

InitLicenseFromServer

Initializes the license and connect to the specified server for online verification.

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

Parameters
[in] licenseServer <string> : The name/IP of the license server.
[in] licenseKey <string> : The license key of Barcode Reader.

Return Value
Returns error code.

Code Snippet

int iLicMsg = -1;
BarcodeReader _br = new BarcodeReader();
// Connect to Dynamsoft server to verify the license. 
iLicMsg = _br.InitLicenseFromServer("", "licenseKey1;licenseKey2");
if(iLicMsg != 0)
{
   Console.WriteLine("License error Code:",iLicMsg);
   return; 
}
// Decode barcodes happens here
//....
_br.Dispose();

InitLicenseFromLicenseContent

Initializes barcode reader license and connects to the specified server for online verification.

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

Parameters
[in] licenseKey <string> : The license key of Barcode Reader.
[in] pLicenseContent <string> : An encrypted string representing the license content (runtime number, expiry date, barcode type, etc.) obtained from the method OutputLicenseToString().

Return Value
Returns error code.

Code Snippet

int iLicMsg = -1;
BarcodeReader _br = new BarcodeReader();
// Use the SDK offline 
iLicMsg = _br.InitLicenseFromLicenseContent("licenseKey1;licenseKey2", "LicenseContent");
if(iLicMsg != 0)
{
   Console.WriteLine("License error Code:",iLicMsg);
   return; 
}
// Decode barcodes happens here
//....
_br.Dispose();

OutputLicenseToString

Outputs the license content as an encrypted string from the license server to be used for offline license verification.

string Dynamsoft.DBR.BarcodeReader.OutputLicenseToString()

Return Value
The output string which stores the contents of license.

Code Snippet

int iLicMsg = -1;
string path = @"Put your file path here";
// To be able to use the license key offline, you need to store the license file obtained from Dynamsoft server once you use the API, InitLicenseFromServer.
BarcodeReader _br = new BarcodeReader();
// Check if there is a license file in the local machine. If not, connect to Dynamsoft Hosted server to verify the license. Otherwise, use the local license file.
if (!File.Exists(path))
{
   // Connect to Dynamsoft server to verify the license
   iLicMsg = _br.InitLicenseFromServer("", "licenseKey1;licenseKey2");
   // The first parameter is the string of the license server. Leaving it empty ("") means it will connect to Dynamsoft License Server for online verification.
   if(iLicMsg != 0)
   {
      Console.WriteLine("License error Code:",iLicMsg);
      return; 
   }
   // If you wish to use SDK offline, store the license information as txt format
   string license = _br.OutputLicenseToString();
   File.WriteAllText(path, license);
}
else{
   // Use the local license file and use Dynamsoft Barcode Reader SDK 
   string license = File.ReadAllText(path);
   iLicMsg = _br.InitLicenseFromLicenseContent("licenseKey1;licenseKey2",license);
   if(iLicMsg != 0)
   {
      Console.WriteLine("Error Code:",iLicMsg);
      return; 
   }
}
// Decode barcodes happens here
//....

InitDLSConnectionParameters

Initializes a DMDLSConnectionParameters struct with default values.

static DMDLSConnectionParameters Dynamsoft.DBR.BarcodeReader.InitDLSConnectionParameters()

Code Snippet

DMDLSConnectionParameters dlsInfo = BarcodeReader.InitDLSConnectionParameters();
dlsInfo.HandShake = "*****-hs-****";
dlsInfo.SessionPassword = "******";
string errorMsg;
BarcodeReader.InitLicenseFromDLS(dlsInfo, out errorMsg);
BarcodeReader reader = new BarcodeReader();

InitLicenseFromDLS

Initializes the barcode reader license and connects to the specified server for online verification.

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

Parameters
[in] dlsConnectionParameters <string> : The struct DMDLSConnectionParameters with customized settings.
[in, out] errorMsg <string> : The detailed error message.

Return Value
Returns error code.

Code Snippet

DMDLSConnectionParameters dlsInfo = BarcodeReader.InitDLSConnectionParameters();
dlsInfo.HandShake = "*****-hs-****";
dlsInfo.SessionPassword = "******";
string errorMsg;
BarcodeReader.InitLicenseFromDLS(dlsInfo, out errorMsg);
BarcodeReader reader = new BarcodeReader();

GetIdleInstancesCount

Gets available instances count when charging by concurrent instances count.

static int Dynamsoft.DBR.BarcodeReader.GetIdleInstancesCount()

Return Value
Returns available instances count.

Code Snippet

//...
int count = BarcodeReader.GetIdleInstancesCount();
if(count > 0)
{
  //create instance and process further
}
else 
{
  //waiting for available instances 
}

InitLTSConnectionParameters

Deprecated. Use InitDLSConnectionParameters instead.

InitLicenseFromLTS

Deprecated. Use InitLicenseFromDLS instead.

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

version 8.9.3

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