License Functions

DBR_InitLicense

Initializes license key and activate the SDK.

DBR_API int DBR_InitLicense (const char* pLicense, char errorMsgBuffer[], const int errorMsgBufferLen)

Parameters

[in] pLicense The license string.

[in, out] errorMsgBuffer The buffer is allocated by caller and the recommended length is 512. The error message will be copied to the buffer.

[in] errorMsgBufferLen The length of allocated buffer.

Return Value

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

You can call DBR_GetErrorString to get detailed error message.

Code Snippet

char errorBuf[512];
DBR_InitLicense("YOUR-LICENSE-KEY", errorBuf, 512);
void* barcodeReader = DBR_GetInstance();
if(barcodeReader != NULL)
{
    // add further process
    DBR_RecycleInstance(barcodeReader);
}

DBR_GetDeviceUUID

Gets the device uuid used for license activating.

DBR_API int DBR_GetDeviceUUID(int uuidGenerationMethod, char ** uuid)

Parameters

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

• 1: Generates UUID with random values.
• 2: Generates UUID based on hardware info.

[out] uuid The result UUID.

Return Value

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

You can call DBR_GetErrorString to get detailed error message.

Remarks

The method DBR_FreeString needs to be called to release memory allocated for the result UUID.

DBR_IsInstanceValid

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

DBR_API int DBR_IsInstanceValid (void* barcodeReader)

Parameters

[in] barcodeReader Handle of a Dynamsoft Barcode Reader instance.

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.

DBR_SetDeviceFriendlyName

Sets a human-readable name that identifies the device.

DBR_API int DBR_SetDeviceFriendlyName(const char* name)

Parameters

[in] name The device alias.

Return Value

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

You can call DBR_GetErrorString to get detailed error message.

Code Snippet

char errorBuf[512];
DBR_SetDeviceFriendlyName("My-PC");
DBR_InitLicense("YOUR-LICENSE-KEY", errorBuf, 512);
void* barcodeReader = DBR_GetInstance();
if(barcodeReader != NULL)
{
	// add further process
    DBR_RecycleInstance(barcodeReader);
}

DBR_SetLicenseCachePath

Sets a directory path for saving the license cache.

DBR_API int DBR_SetLicenseCachePath(const char* directoryPath)

Parameters

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

Return Value

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

You can call DBR_GetErrorString to get detailed error message.

Code Snippet

char errorBuf[512];
DBR_SetLicenseCachePath("DIRECTORY-PATH-FOR-LICENSE-CACHE");
DBR_InitLicense("YOUR-LICENSE-KEY", errorBuf, 512);
void* barcodeReader = DBR_GetInstance();
if(barcodeReader != NULL)
{
	// add further process
    DBR_RecycleInstance(barcodeReader);
}

DBR_SetMaxConcurrentInstanceCount

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

DBR_API void DBR_SetMaxConcurrentInstanceCount(int countForThisDevice, int countForThisProcess)

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.

Code Snippet

char errorBuf[512];
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
DBR_SetMaxConcurrentInstanceCount(countForThisDevice, countForThisProcess);
DBR_InitLicense("YOUR-LICENSE-KEY", errorBuf, 512);
void* dbr = DBR_GetInstance();
// If no instance is available right away, the application will wait until one becomes available
if(dbr != 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
    DBR_RecycleInstance(dbr);
}

DBR_SetMaxConcurrentInstanceCountEx

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

DBR_API void DBR_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

char errorBuf[512];
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
int timeout = 100; // The timeout value should be set based on your requirement
DBR_SetMaxConcurrentInstanceCountEx(countForThisDevice, countForThisProcess, timeout);
DBR_InitLicense("YOUR-LICENSE-KEY", errorBuf, 512);
void* dbr = DBR_GetInstance();
// If no instance is available right away, the application will wait until one becomes available
if(dbr != 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
    DBR_RecycleInstance(dbr);
}

DBR_GetInstancePoolStatus

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

DBR_API InstancePoolStatus DBR_GetInstancePoolStatus()

Return Value

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

DBR_GetIdleInstancesCount

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

DBR_API int DBR_GetIdleInstancesCount()

DBR_InitLicenseFromServer

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

DBR_API int DBR_InitLicenseFromServer (void* barcodeReader, const char* pLicenseServer, const char* pLicenseKey)

DBR_InitLicenseFromLicenseContent

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

DBR_API int DBR_InitLicenseFromLicenseContent (void* barcodeReader, const char* pLicenseKey, const char* pLicenseContent)	

DBR_OutputLicenseToString

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

DBR_API int DBR_OutputLicenseToString (void* barcodeReader, char content[], int contentLen)

DBR_OutputLicenseToStringPtr

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

DBR_API int DBR_OutputLicenseToStringPtr (void* barcodeReader, char** content)

DBR_FreeLicenseString

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

DBR_API void DBR_FreeLicenseString (char** content)

DBR_InitDLSConnectionParameters

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

DBR_API int DBR_InitDLSConnectionParameters (DM_DLSConnectionParameters *pDLSConnectionParameters)

DBR_InitLicenseFromDLS

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

DBR_API int DBR_InitLicenseFromDLS(DM_DLSConnectionParameters *pDLSConnectionParameters, char errorMsgBuffer[], const int errorMsgBufferLen)

DBR_InitLTSConnectionParameters

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

DBR_InitLicenseFromLTS

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