Dynamsoft Barcode Reader 6.3.0 - API Reference
Functions

Functions

DBR_API int DBR_LoadSettingsFromFile (void *hBarcode, const char *pszFilePath, char szErrorMsgBuffer[], int nErrorMsgBufferLen)
 
DBR_API int DBR_LoadSettings (void *hBarcode, const char *pszContent, char szErrorMsgBuffer[], int nErrorMsgBufferLen)
 
DBR_API int DBR_AppendParameterTemplateFromFile (void *hBarcode, const char *pszFilePath, char szErrorMsgBuffer[], int nErrorMsgBufferLen)
 
DBR_API int DBR_AppendParameterTemplate (void *hBarcode, const char *pszContent, char szErrorMsgBuffer[], int nErrorMsgBufferLen)
 
DBR_API int DBR_GetTemplateSettings (void *hBarcode, const char *pszTemplateName, PublicParameterSettings *pSettings)
 
DBR_API int DBR_SetTemplateSettings (void *hBarcode, const char *pszTemplateName, PublicParameterSettings *pSettings, char szErrorMsgBuffer[], int nErrorMsgBufferLen)
 

Detailed Description

Function Documentation

◆ DBR_AppendParameterTemplate()

DBR_API int DBR_AppendParameterTemplate ( void *  hBarcode,
const char *  pszContent,
char  szErrorMsgBuffer[],
int  nErrorMsgBufferLen 
)

Ensure compatibility with earlier versions. It is functionally equivalent to DBR_AppendTplStringToRuntimeSettings with conflict mode ECM_Overwrite as default.

Deprecated:
DBR_AppendParameterTemplate
Parameters
[in]hBarcodeHandle of the barcode reader instance.
[in]pszContentA JSON string that represents the content of the settings.
[in,out]szErrorMsgBufferThe buffer is allocated by caller and the recommended length is 256. The error message will be copied to the buffer.
[in]nErrorMsgBufferLenThe length of the allocated buffer.
Returns
Returns error code. Returns 0 if the function completed successfully, otherwise call DBR_GetErrorString to get detail message.
See also
DBR_AppendTplStringToRuntimeSettings

◆ DBR_AppendParameterTemplateFromFile()

DBR_API int DBR_AppendParameterTemplateFromFile ( void *  hBarcode,
const char *  pszFilePath,
char  szErrorMsgBuffer[],
int  nErrorMsgBufferLen 
)

Ensure compatibility with earlier versions. It is functionally equivalent to DBR_AppendTplFileToRuntimeSettings with conflict mode ECM_Overwrite as default.

Deprecated:
DBR_AppendParameterTemplateFromFile
Parameters
[in]hBarcodeHandle of the barcode reader instance.
[in]pszFilePathThe path of the settings file.
[in,out]szErrorMsgBufferThe buffer is allocated by caller and the recommended length is 256. The error message will be copied to the buffer.
[in]nErrorMsgBufferLenThe length of the allocated buffer.
Returns
Returns error code. Returns 0 if the function completed successfully, otherwise call DBR_GetErrorString to get detail message.
See also
DBR_AppendTplFileToRuntimeSettings

◆ DBR_GetTemplateSettings()

DBR_API int DBR_GetTemplateSettings ( void *  hBarcode,
const char *  pszTemplateName,
PublicParameterSettings pSettings 
)

Ensure compatibility with earlier versions. It is functionally equivalent to DBR_GetRuntimeSettings.

Deprecated:
DBR_GetTemplateSettings
Parameters
[in]hBarcodeHandle of the barcode reader instance.
[in]pszTemplateNameThe template name.
[in,out]pSettingsThe struct of template settings.
Returns
Returns error code. Returns 0 if the function completed successfully, otherwise call DBR_GetErrorString to get detail message.
See also
DBR_GetRuntimeSettings

◆ DBR_LoadSettings()

DBR_API int DBR_LoadSettings ( void *  hBarcode,
const char *  pszContent,
char  szErrorMsgBuffer[],
int  nErrorMsgBufferLen 
)

Ensure compatibility with earlier versions. It is functionally equivalent to DBR_InitRuntimeSettingsWithString with conflict mode ECM_Overwrite as default.

Deprecated:
DBR_LoadSettings
Parameters
[in]hBarcodeHandle of the barcode reader instance.
[in]pszContentA JSON string that represents the content of the settings.
[in,out]szErrorMsgBufferThe buffer is allocated by caller and the recommended length is 256. The error message will be copied to the buffer.
[in]nErrorMsgBufferLenThe length of the allocated buffer.
Returns
Returns error code. Returns 0 if the function completed successfully, otherwise call DBR_GetErrorString to get detail message.
See also
DBR_InitRuntimeSettingsWithString

◆ DBR_LoadSettingsFromFile()

DBR_API int DBR_LoadSettingsFromFile ( void *  hBarcode,
const char *  pszFilePath,
char  szErrorMsgBuffer[],
int  nErrorMsgBufferLen 
)

Ensure compatibility with earlier versions. It is functionally equivalent to DBR_InitRuntimeSettingsWithFile with conflict mode ECM_Overwrite as default.

Deprecated:
DBR_LoadSettingsFromFile
Parameters
[in]hBarcodeHandle of the barcode reader instance.
[in]pszFilePathThe path of the settings file.
[in,out]szErrorMsgBufferThe buffer is allocated by caller and the recommended length is 256. The error message will be copied to the buffer.
[in]nErrorMsgBufferLenThe length of the allocated buffer.
Returns
Returns error code. Returns 0 if the function completed successfully, otherwise call DBR_GetErrorString to get detail message.
See also
DBR_InitRuntimeSettingsWithFile

◆ DBR_SetTemplateSettings()

DBR_API int DBR_SetTemplateSettings ( void *  hBarcode,
const char *  pszTemplateName,
PublicParameterSettings pSettings,
char  szErrorMsgBuffer[],
int  nErrorMsgBufferLen 
)

Ensure compatibility with earlier versions. It is functionally equivalent to DBR_UpdateRuntimeSettings.

Deprecated:
DBR_SetTemplateSettings
Parameters
[in]hBarcodeHandle of the barcode reader instance.
[in]pszTemplateNameThe template name.
[in]pSettingsThe struct of template settings.
[in,out]szErrorMsgBufferThe buffer is allocated by caller and the recommended length is 256. The error message will be copied to the buffer.
[in]nErrorMsgBufferLenThe length of the allocated buffer.
Returns
Returns error code. Returns 0 if the function completed successfully, otherwise call DBR_GetErrorString to get detail message.
See also
DBR_UpdateRuntimeSettings