Click or drag to resize

ScannerInit Method

This method initializes the scanner.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public void Init(
	bool Asynchronously,
	[OptionalAttribute] string FileName
)

Parameters

Asynchronously
Type: SystemBoolean
FileName (Optional)
Type: SystemString
Remarks

The application must call this method prior to any property altering or method calls. Note that - depending on the scanner model - this operation might take several seconds. Once the initialization is done, the ScanInitFinished event is fired.

If the StartThread parameter is True the initialization is performed in a separate thread and the method returns immediately. Otherwise the initialization is performed synchronously, i.e. the method does not return until the initialization is finished.

The FileName is an optional string parameter, which can be a fully qualified path to a setting file. Once the initialization is complete, the scanner parameters are automatically loaded from the specified location.

If the scanner is already initialized, no re-initialization is done, but its settings are refreshed accordingly if the FileName parameter is specified.

The ScanInitFinished event is fired only if the initialization was successful.

See Also