KofaxOmniPage Capture SDK Help
×
  • Welcome to Kofax OmniPage Capture SDK
    • Introduction
      • System requirements
      • Product documentation
    • Programming the toolkit
      • Sample viewer application
    • Distributing the application
      • Prepare the distribution
      • Redistributable Microsoft file sets for deployments
      • Set up the CSDK scanning sub-system in the redistribution
    • Related pages
      • Performance comparison of Engine combinations
      • Image size limits
    • Uninstall the product
    • Abbreviations
  • Use Capture SDK
    • Overview
      • Verify the installation
      • Overview of building and distributing applications
      • Interface properties
      • Sample viewer application
      • Distribute the application
        • Prepare distribution file set
        • Test applications using temporary test licenses
      • Performance comparison of Engine combinations
      • Image size limits
    • RecAPI
      • Introduction to RecAPI
        • RecAPI modules
      • KernelAPI modules
        • General operations module
        • Error handling module
        • Image file handling module
        • Image handling module
          • About MRC image compression
          • MRC image compression level comparison
        • Scanning module
        • Settings manager module
        • Zone handling module
        • Form recognition module
          • Analyze and activate empty forms
          • Process filled forms
        • Direct TXT Output Converter Module
        • Language, Character Set, and Code Page Handling Module
        • Recognition module
        • Recognition data handling module
        • Spell checking module
        • Table recognition module
      • Alternate linking of RecAPI
      • RecAPIPlus
    • IPRO
      • ComKit Libraries
      • Potential deadlock situations
      • IPRO object model
      • Object summaries
        • BarcodeType / BarcodeTypes
        • Character / Characters
        • ConverterEnumValue / ConverterEnumValues
        • Converter / Converters
        • ConverterProperty
        • Document / Documents
        • Engine
        • Image
        • ImageFile / ImageFiles
        • ImageInfo
        • Link / Links
        • MemoryBitmap / MemoryBitmaps
        • ModuleInfo / ModuleInfos
        • OCRZone / OCRZones
        • Page / Pages
        • RecognitionLanguage / RecognitionLanguages
        • RemovedLine / RemovedLines
        • Scanner / Scanners
        • SearchText
        • SettingManager
        • SettingNode
        • SpellLanguage / SpellLanguages
        • Statistics
        • TableCell / TableCells
        • UDItem / UDItems
        • UDManager
        • UDSection / UDSections
        • UILanguage / UILanguages
        • UserZone / UserZones
        • VerticalDictionary / Vertical Dictionaries
        • WFDescInfo
        • WFHandler
        • WFProcInfo
    • Introduction to Visual Toolbox
      • Overview
      • MediumWeightVisuals
      • Visuals
    • Formatted output
      • Footnotes
        • Limitations
        • Troubleshooting
      • Essay mode
        • Styles in Essay mode
        • Heading styles
        • Character styles
        • Paragraph styles
        • Style naming rules
        • Troubleshooting
        • Use essay mode
    • Handwritten text recognition
      • Automatic handwriting and zone detection
      • Choosing the filling method for user zones
      • Low-level functions for separating handwritten and machine printed texts
        • Use cases for separating handwritten text
      • Filtering the set of characters
    • Profiles
      • Built in scenarios
    • Use cases and related code samples
      • Code samples for language detection
      • Code sample for handling large volume output
      • Code sample for image loading
      • Code samples for image processing
  • Document Classifier Assistant
    • Install Document Classifier Assistant
    • Basic usage
      • Workflows
        • Single source - Single document type Workflow
        • Single source - Multiple document type Workflow
        • Multiple source - Single document type Workflow
        • Multiple source - Multiple document type Workflow
        • Random test set type Workflow
        • Use Case
    • Advanced usage
      • Alien documents
    • DCTool command-line supplement
    • Uninstall the product
    • Reference
      • Project structure
        • Training set
          • Training set Classes
        • Stopwords
        • Metawords
        • Phrases
        • Test set
          • Test set Classes
      • User interface reference
        • Menus
        • Toolbars
        • Output
  • Form Template Editor
    • Operation of Form Template Editor
    • Installation
    • Using the Form Template Editor
      • Start the application
      • Add a template
      • Add a template (alternatives)
        • Add a template using the File menu
        • Add a template using the context menu
        • Add a template folder using the context menu
      • Define zones
        • Define zones automatically (auto process page)
        • Define zones automatically (auto process area)
        • Define text anchor zones
        • Define barcode anchor zones
        • Define fill text zones
          • Define datarules
          • Use zone filter
            • Edit FilterPlus
        • Define fillable barcode zones
        • Define check box zones
        • Define graphic zones
        • Define comb zones
          • Comb edit mode operations
        • Define table zones
          • Table edit mode operations
      • Create reference between two or more zones
      • Drop out pre-printed color
      • Set reading order
      • Test template library
      • Adapt template to image
      • Adapt zones from template
    • Uninstalling the product
    • Troubleshooting
    • User interface reference
      • Menu bar
      • Status bar
      • Ribbon interface
        • File menu
        • Home tab
        • Library tab
        • Template tab
        • Zone selections tab
        • Arrange zones tab
        • Comb tab
        • Table tab
      • Ribbon key tips
      • More key navigation tips
      • Options
    • Reference
      • Library
      • Template
      • Zones
        • Zone property grids
        • Reference zone
          • Displaying references
      • Anchors
        • Anchor type
        • Anchor content
        • Text anchor zone colors
        • Barcode anchor zone colors
      • Drift area
      • Dropout color picker
      • Language Collection Editor
      • Reading order
        • Left to right
        • Top to bottom
        • By rows
        • By columns
        • Reverse order
      • Data rule
      • Form template adaptation
  • Intelligent Workflow Runner
    • Overview
      • Register IWR API components
      • Unregister IWR API components
      • Workflow job items and related objects
        • Parameters of OCRService.ini
        • Parameters of the Done event
      • Workflow XML Designer
        • User interface
          • Properties panel
          • Settings dialog box
        • Menu commands
      • Customizing workflows
        • Best practices for designing a job item
        • Best practices for designing a worker job item
          • Debug a worker job item in OCRServer.exe
          • Debug a worker job item using IWR_InprocCore.exe
        • Tips and tricks
      • Customizing Workflow XML Designer job items and tools
        • Install the Visual Studio templates
        • Add a custom job item
        • Add a custom tool
        • Develop a custom job item
        • Develop a custom job item from scratch
      • IWR.exe command-line tool
      • XWFToXML.exe commandline tool
      • Workflow XML Designer API
    • Sample application
    • Sample steps for using OCRService
  • API documentation
    • IPROPlus
    • Objects
    • RecAPI
    • Toolboxes
 › Use Capture SDK › RecAPI › KernelAPI modules

KernelAPI modules

This section describes the following modules:

  • Direct TXT Output Converter Module

  • Error handling module

  • Form recognition module

  • General operations module

  • Image file handling module

  • Image handling module

  • Language, Character Set, and Code Page Handling Module

  • Recognition data handling module

  • Recognition module

  • Scanning module

  • Settings manager module

  • Spell checking module

  • Table recognition module

  • Zone handling module

Search results

Search tips

The search returns topics that contain terms you enter. If you type more than one term, an OR is assumed, which returns topics where any of the terms are found. Enclose your search terms in quotes for exact-phrase matching.

The search also uses fuzzy matching to account for partial words (such as install and installs). The results appear in order of relevance, based on how many search terms occur per topic. Exact matches are highlighted.

To refine the search, you can use the following operators:

  • Type + in front of words that must be included in the search or - in front of words to exclude. (Example: user +shortcut –group finds shortcut and user shortcut, but not group or user group.)
  • Use * as a wildcard for missing characters. The wildcard can be used anywhere in a search term. (Example: inst* finds installation and instructions.)
  • Type title: at the beginning of the search phrase to look only for topic titles. (Example: title:configuration finds the topic titled “Changing the software configuration.”)
  • For multi-term searches, you can specify a priority for terms in your search. Follow the term with ^ and a positive number that indicates the weight given that term. A higher number indicates more weight. (Example: shortcut^10 group gives shortcut 10 times the weight as group.)
  • To use fuzzy searching to account for misspellings, follow the term with ~ and a positive number for the number of corrections to be made. (Example: port~1 matches fort, post, or potr, and other instances where one correction leads to a match.)

Note that operators cannot be used as search terms: + - * : ~ ^ ' "