L_OcrSettingManager_GetSettingDescriptors - OCR Module - LEAD Engine C++ API Help

L_OcrSettingManager_GetSettingDescriptors

#include "ltocr.h"

L_LTOCR_API L_INT EXT_FUNCTION L_OcrSettingManager_GetSettingDescriptors(settingManager, value, count)

L_OcrSettingManager settingManager; handle to the OCR engine setting manager
L_OcrSettingDescriptor** value; pointer to L_OcrSettingDescriptor* to be allocated and updated with the settings descriptors
L_UINT* count; pointer to L_UINT variable to be updated with the number of allocated descriptors

Gets all settings descriptors at once.

Parameter Description
settingManager Handle to the OCR engine setting manager.
value Pointer to L_OcrSettingDescriptor* to be allocated and updated with the settings descriptors, you should declare a variable of type L_OcrSettingDescriptor* and pass its address.
You should call L_OcrMemory_Free after you are done with these setting descriptors in order to free the allocated memory.
count Pointer to L_UINT variable to be updated with the number of allocated descriptors.

Returns

SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

This function gets all settings descriptors at once.

LEADTOOLS OCR Module - LEAD Engine contain specific additional features and functionality that can be queried and updated using different L_OcrSettingManager handle functions.

You can use the different methods of the L_OcrSettingManager handle to get and set the engine-specific settings. Each setting has a unique name (a string value). You can get all the settings available to the current OCR engine through the L_OcrSettingManager_GetSettingName method. The L_OcrSettingManager_GetSettingDescriptor and L_OcrSettingManager_GetSettingDescriptors methods returns a description of the setting (its type, friendly name and value range), you can then use the various setting get and set methods to query and change the value of a certain setting. For example, if the setting type is L_OcrSettingValueType_Integer, you can use the L_OcrSettingManager_GetIntegerValue to get the current value of the setting and the L_OcrSettingManager_SetIntegerValue to change its value. Refer to L_OcrEngine_GetSettingManager for a complete example.

Note: You should call L_OcrMemory_Free after you are done with these setting descriptors in order to free the allocated memory.

Required DLLs and Libraries

LTOCR
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Help Version 20.0.2018.6.21
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS OCR Module - LEAD Engine C API Help