Click or drag to resize

EngineTimeOut Property

This property defines the engine-wide module timeout setting.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public int TimeOut { get; set; }

Property Value

Type: Int32
Remarks

This setting is used by IPRO to implement a watch-dog feature for avoiding rare but annoying dead-lock situations (infinite loops). In the current release this feature is used to monitor the image preprocessing, page parsing (auto-zoning) and recognition processes.

The value specified here is either a time value measured in milliseconds or INFINITE. A set time value prevents any module from processing an image for more than the time specified. The value of INFINITE disables IPRO's watch-dog feature.

When the specified time is exceeded, the Engine terminates the running of the appropriate module and resets it. The calling method will return with the API_TIMEOUT_ERR return code to the integrating application signaling that the processing of the image could not be successfully completed in the time allowed.

The default value of this property is 180000 milliseconds (3 minutes), i.e. no process will be allowed to continue for more than three minutes.

If the Engine is not initialized, accessing this property raises a trappable error.

An inappropriately low timeout value set for this property might lead to Engine instability if the timeout is less than the time required for the related modules to load. Due to this, if you decide to override the default timeout value (180000 milliseconds - 3 minutes) make sure you do not set it to less than 50 ms.

See Also