Help Version 19.0.2017.10.27
References ▼
#include "ltocr.h"
L_LTOCR_API L_INT EXT_FUNCTION L_OcrSettingManager_GetStringValue(settingManager, settingName, value)
| L_OcrSettingManager settingManager; | handle to the OCR engine setting manager |
| const L_TCHAR* settingName; | unique setting name |
| L_TCHAR** value; | pointer to L_TCHAR* variable to be updated with the setting string value |
Gets the current value of a string setting.
| Parameter | Description |
|---|---|
| settingManager | Handle to the OCR engine setting manager. |
| settingName | Name of the setting you wish to get its string value. This is the value you retrieved with a call to L_OcrSettingManager_GetSettingName method. |
| value | Pointer to L_TCHAR* variable to be updated with the setting string value, you should declare a variable of type L_TCHAR* and pass its address. You have to call L_OcrMemory_Free after you are done with this buffer to free the allocated memory. |
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
Gets the current value of a string setting.
The settingName setting must be a "string" type setting, otherwise; this method will return an error. To get the type of a setting along with other information such as its friendly name and range use the L_OcrSettingManager_GetSettingDescriptor method.
To set the value of a string setting, use L_OcrSettingManager_SetStringValue.
You can also set the value of any setting from a string (where the string will be converted to a compatible type) using L_OcrSettingManager_SetValue. To get the value of any setting as a string, use L_OcrSettingManager_GetValue. Note that settings of type L_OcrSettingValueType_BeginCategory and L_OcrSettingValueType_EndCategory have no values and will return an error if you try to get or set their values.
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_String, you can use the L_OcrSettingManager_GetStringValue to get the current value of the setting and the L_OcrSettingManager_SetStringValue to change its value. Refer to L_OcrEngine_GetSettingManager for a complete example.
Note: You have to call L_OcrMemory_Free after you are done with this buffer 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. |
For an example, refer to L_OcrSettingManager_LoadFile.