L_OcrSettingManager_GetEnumValue

#include "ltocr.h"

L_LTOCR_API L_INT EXT_FUNCTION L_OcrSettingManager_GetEnumValue(settingManager, settingName, value)

Gets the current value of an enum setting as an unsigned integer.

Returns

Comments

Gets the current value of an enum setting as an unsigned integer.

This method returns the value as an unsigned integer, if the enum is not a flag enum type (the value of L_OcrSettingDescriptor.EnumIsFlags of the L_OcrSettingDescriptor for this setting is false, then the unsigned integer value of the setting is the unsigned integer value of the enum member (The enum member friendly names can be obtained with L_OcrSettingDescriptor.EnumMemberFriendlyNames).

If the enum is a flag enum type (the value of L_OcrSettingDescriptor.EnumIsFlags of the L_OcrSettingDescriptor for this setting is true, then the unsigned integer value of the setting is the sum of the OR'ed flagged set.

The settingName setting must be an "enum" 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 an enum setting, use L_OcrSettingManager_SetEnumValue.

To get or set the enum value from a string value, use L_OcrSettingManager_GetEnumValueAsString or L_OcrSettingManager_SetEnumValueAsString.

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_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