#include "ltocr.h"

L_LTOCR_API L_INT EXT_FUNCTION L_OcrSettingManager_GetSettingDescriptor(settingManager, settingName, value)

L_OcrSettingManager settingManager; handle to the OCR engine setting manager
const L_TCHAR* settingName; setting name
L_OcrSettingDescriptor* value; pointer to L_OcrSettingDescriptor structure to be updated with the setting descriptor of the passed setting name

Gets the descriptor of the given setting name.

Parameter Description
settingManager Handle to the OCR engine setting manager.
settingName Name of the setting you wish to get its descriptor. This is the value you retrieved with a call to L_OcrSettingManager_GetSettingName method.
value Pointer to L_OcrSettingDescriptor structure to be updated with the setting descriptor of the passed setting name.


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


This function gets the descriptor of the given setting name.

Advantage OCR 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.

Required DLLs and Libraries

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 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.