L_OcrSettingDescriptor

Summary

Defines a setting name, friendly name, type and range.

Syntax

struct L_OcrSettingDescriptor 
{ 
   L_UINT StructSize; 
   L_TCHAR Name[120]; 
   L_OcrSettingValueType ValueType; 
   L_TCHAR FriendlyName[120]; 
   L_TCHAR Units[120]; 
   L_INT IntegerMinimumValue; 
   L_INT IntegerMaximumValue; 
   L_BOOL EnumIsFlags; 
   L_TCHAR EnumMemberFriendlyNames[1024]; 
   L_DOUBLE DoubleMinimumValue; 
   L_DOUBLE DoubleMaximumValue; 
   L_BOOL StringNullAllowed; 
   L_INT StringMaximumLength; 
}; 
typedef struct L_OcrSettingDescriptor L_OcrSettingDescriptor; 

Members

StructSize

Structure size. It should be equal to sizeof(L_OcrSettingDescriptor).

Name

The unique name of setting. This is the same name you pass to L_OcrSettingManager_GetSettingDescriptor.

ValueType

Specifying the setting type. For a list of possible values, refer to L_OcrSettingValueType.

FriendlyName

Friendly name of the setting. You can use this name in your user application.

Units

Name of the unit of the value.

IntegerMinimumValue

Minimum allowed value of the setting.

IntegerMaximumValue

Maximum allowed value of the setting.

EnumIsFlags

If TRUE, the enum setting members can be combined together (OR'ed), otherwise; only one enum member can be set at a time.

EnumMemberFriendlyNames

Character string containing the enumeration members friendly names separated by commas. You can use these names in your user application.

DoubleMinimumValue

Minimum allowed value of the setting.

DoubleMaximumValue

Maximum allowed value of the setting.

StringNullAllowed

A NULL is a valid value for this setting.

StringMaximumLength

Maximum number of characters in the value of the setting.

Comments

You can use the different methods of the L_OcrSettingManager to get and set the engine-specific settings. Each setting has a unique name (a character array value). You can get all the settings available to the current OCR engine through the L_OcrSettingManager_GetSettingCount and L_OcrSettingManager_GetSettingName methods. The L_OcrSettingManager_GetSettingDescriptor method 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.

For a list of supported engine-specific settings and their meanings, refer to LEADTOOLS OCR Module - LEAD Engine Settings.

Usage

• L_OcrSettingManager_GetSettingDescriptor
• L_OcrSettingManager_GetSettingDescriptors