IsStarted Property

Summary

Determines whether this IOcrEngine has been started and is ready to be used.

Syntax

Objective-C

C++

Java

public bool IsStarted { get; }

ReadOnly Property IsStarted As Boolean

@property (nonatomic, assign, readonly) BOOL isStarted

public boolean isStarted()

property bool IsStarted { 
   bool get(); 
}

Property Value

true if this IOcrEngine has been started and is ready to be used, otherwise it is false.

Remarks

The Startup method must be called before invoking any other methods or properties in this IOcrEngine.

To check if the engine is started, use the IsStarted property.

You must call Shutdown to shut down the engine and free the memory and resources used.

You can call the Startup method multiple times, only the first call will start the engine while subsequent calls will only increment an internal counter. You must call Shutdown for each Startup called.

The IOcrEngine interface implements IDisposable. It is highly recommended that you call Dispose (or use the using statement in C# or Using statement in VB) when creating the IOcrEngine instance. The Dispose method will automatically shut down the engine if it has been started.

Example

For an example, refer to Startup.

Requirements

Target Platforms