IsSettingNameSupported Method

Summary

Gets a value indicating whether the given setting name is supported by the IOcrEngine.

Syntax

Objective-C

C++

Java

public bool IsSettingNameSupported( 
   string settingName 
)

Function IsSettingNameSupported( _ 
   ByVal settingName As String _ 
) As Boolean

- (BOOL)isSettingNameSupported:(NSString *)settingName

public boolean isSettingNameSupported(String settingName)

bool IsSettingNameSupported(  
   String^ settingName 
)

Parameters

settingName
Unique setting name.

Return Value

True if the setting name given by settingName is supported by the IOcrEngine; otherwise it is false.

Remarks

IOcrEngine is a wrapper for different OCR engines. These engines contain specific additional features and functionalities that can be queried and updated using the IOcrSettingManager interface.

You can use the different methods of the IOcrSettingManager interface 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 GetSettingNames method. The 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 OcrSettingValueType.Integer, you can use the GetIntegerValue to get the current value of the setting and the SetIntegerValue to change its value. Refer to IOcrSettingManager for a complete example.

Example

For an example, refer to IOcrSettingManager.

Requirements

Target Platforms