how-to.inliteresearch.comInlite Knowledge Base

Products Company 408.737.7092 support@inliteresearch.com General ClearImage API and Initialization Open and Save image files Use threads to process multiple files Read Barcodes From an image page From a multi-page file, stream, and using threads Driver License Barcodes Targeted Barcode Reader (TBR) Poor quality and damaged barcodes Image zones and other operations Barcode data and properties Web API Barcode Reader Web API Barcode Reader (WaBR) Web API Barcode Reader Server Installation Repair Images Read MICR Online Help ClearImage Reference Driver License Reader Reference (COM API) Barcode Director User Manual PDF Imprint User Manual MICR Reader Reference Check Images IQA Manual Examples How-To: ClearImage Table of contents .NET API COM API Java API ClearImage functionality is packaged as: ClearImageNet.dll – .NET assembly supports AnyCPU, x86 and x64 development. ClearImage.dll – Windows DLL supports COM and JNI entry points. The DLL is distributed as 32-bit version (ClearImage.dll) and 64-bit version (ClearImage.x64.dll). ClearImage COM is registered during the installation process. The following describes the essential steps of using ClearImage in various programming environments. .NET API .NET is a higher level API implemented in the Inlite.ClearImageNet namespace of ClearImageNet.70 . The ClearImageNet assembly also contains a secondary Inlite.ClearImage namespace that is substantially compatible with the COM API, and is specifically designed to ease the migration from ClearImage COM API applications to .NET. It also supports a few low level functions that are not accessible through the Inlite.ClearImageNet namespace. Since it mirrors the COM API no additional examples are provided. To use .NET API add reference to ClearImageNet.70 assembly. Code below demonstrates recommended use of ClearImage .NET API. C# ClearImage .NET usage using Inlite.ClearImageNet; // . . . void printClearImageInfo() { Console.WriteLine("ClearImage Server v." + Server.Major.ToString() + "." + Server.Minor.ToString() + "." + Server.Release.ToString() + " " + Server.Edition); Console.WriteLine(Server.GetThreadServer().get_Info(Inlite.ClearImage.EInfoType.ciModulesList, 0)); } // . . . void ReadBarcodes1D(string fileName, int page) { BarcodeReader reader = null; try { reader = new BarcodeReader(); // Create and configure reader reader.Code39 = true; reader.Code128 = true; Barcode[] barcodes = reader.Read(fileName, page); // Read barcodes foreach (Barcode barcode in barcodes) // Process results { Console.WriteLine("Barcode type: " + barcode.Type.ToString() + " Text: " + Environment.NewLine + barcode.Text); } } catch (Exception ex) { Console.WriteLine("Exception: " + ex.ToString()); } finally { if (reader != null) reader.Dispose(); } // ClearImage 9 and latter. Free image memory. } 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 using Inlite . ClearImageNet ; // . . . void printClearImageInfo ( ) { Console . WriteLine ( "ClearImage Server v." + Server . Major . ToString ( ) + "." + Server . Minor . ToString ( ) + "." + Server . Release . ToString ( ) + " " + Server . Edition ) ; Console . WriteLine ( Server . GetThreadServer ( ) . get_Info ( Inlite . ClearImage . EInfoType . ciModulesList , 0 ) ) ; } // . . . void ReadBarcodes1D ( string fileName , int page ) { BarcodeReader reader = null ; try { reader = new BarcodeReader ( ) ; // Create and configure reader reader . Code39 = true ; reader . Code128 = true ; Barcode [ ] barcodes = reader . Read ( fileName , page ) ; // Read barcodes foreach ( Barcode barcode in barcodes ) // Process results { Console . WriteLine ( "Barcode type: " + barcode . Type . ToString ( ) + " Text: " + Environment . NewLine + barcode . Text ) ; } } catch ( Exception ex ) { Console . WriteLine ( "Exception: " + ex . ToString ( ) ) ; } finally { if ( reader != null ) reader . Dispose ( ) ; } // ClearImage 9 and latter. Free image memory. } VB.NET ClearImage .NET usage Imports Inlite.ClearImageNet ' . . . Private Sub printClearImageInfo() Console.WriteLine("ClearImage Server v." & Server.Major.ToString() & "." & Server.Minor.ToString() & "." & Server.Release.ToString() & " " & Server.Edition) Console.WriteLine(Server.GetThreadServer().get_Info(Inlite.ClearImage.EInfoType.ciModulesList, 0)) End Sub ' . . . Private Sub ReadBarcodes1D(ByVal fileName As String, ByVal page As Integer) Dim reader As BarcodeReader = Nothing Try reader = New BarcodeReader() ' Create and configure reader reader.Code39 = True reader.Code128 = True Dim barcodes() As Barcode = reader.Read(fileName, page) ' Read barcodes For Each barcode As Barcode In barcodes ' Process results Console.WriteLine("Barcode type: " & barcode.Type.ToString() & " Text: " & Environment.NewLine & barcode.Text) Next barcode Catch ex As Exception Console.WriteLine("Exception: " & ex.ToString()) Finally If reader IsNot Nothing Then reader.Dispose() ' ClearImage 9 and latter. Free image memory. End Try End Sub 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 Imports Inlite . ClearImageNet ' . . . Private Sub printClearImageInfo ( ) Console . WriteLine ( "ClearImage Server v." & Server . Major . ToString ( ) & "." & Server . Minor . ToString ( ) & "." & Server . Release . ToString ( ) & " " & Server . Edition ) Console . WriteLine ( Server . GetThreadServer ( ) . get_Info ( Inlite . ClearImage . EInfoType . ciModulesList , 0 ) ) End Sub ' . . . Private Sub ReadBarcodes1D ( ByVal fileName As String , ByVal page As Integer ) Dim reader As BarcodeReader = Nothing Try reader = New BarcodeReader ( ) ' Create and configure reader reader . Code39 = True reader . Code128 = True Dim barcodes ( ) As Barcode = reader . Read ( fileName , page ) ' Read barcodes For Each barcode As Barcode In barcodes ' Process results Console . WriteLine ( "Barcode type: " & barcode . Type . ToString ( ) & " Text: " & Environment . NewLine & barcode . Text ) Next barcode Catch ex As Exception Console . WriteLine ( "Exception: " & ex . ToString ( ) ) Finally If reader IsNot Nothing Then reader . Dispose ( ) ' ClearImage 9 and latter. Free image memory. End Try End Sub ClearImage installers automatically place ClearImageNet.dll in the GAC. To use it locally (e.g. from executable file folder) remove it from the GAC either from the Inlite Control Center’s Versions tab or by running: gacutil -uf ClearImageNet.70 to Top COM API This is a lower level API to support development in all languages that can interface to the Windows COM model. Code below demonstrates recommended use of ClearImage COM API. C++ ClearImage COM API usage #import "progid:ClearImage.ClearImage" exclude("LONG_PTR") exclude("ULONG_PTR") no_namespace named_guids ... int main(int argc, char* argv[]) { CoInitialize(NULL); try { // Initialize COM and ClearImage Server ICiServerPtr Ci; HRESULT hr = Ci.CreateInstance(__uuidof(CiServer)); if (FAILED(hr)) _com_issue_error(hr); // Print version and licensing information cout << "ClearImage COM Version " << Ci->VerMajor << "." << Ci->VerMinor << "." << Ci->VerRelease << endl; cout << Ci->GetInfo(ciModulesList, 0) << endl; // ClearImage API calls, e.g. read barcodes ReadBarcode1D (Ci, "SomeImageFileName", 1); } catch (_com_error e) { printf("_com_error: %s\n", (LPCSTR)e.Description()); } catch (...) { printf("Unknown Exception\n"); } CoUninitialize(); } ... void ReadBarcode1D(ICiServerPtr& Ci, char* sFileName, int nPage) { ICiBarcodeProPtr reader = NULL; try { reader = Ci->CreateBarcodePro(); reader->Type = (FBarcodeType)(cibfCode128 | cibfCode39); reader->Image->Open(_bstr_t(sFileName), nPage); // Open image reader->Find(0); for (int i = 1; i <= reader->Barcodes->Count; i++) { CiBarcode barcode = reader->Barcodes->Item[i]; cout << "Barcode Type= " << barcode->Type << " Text= " << barcode-...