ntwain/README.markdown

TWAIN Application-Side Library
==============================

Info
--------------------------------------
This is a dotnet library created to work with [TWAIN](http://twain.org/) interface. 
This project has these features:

* Targets latest TWAIN version (2.3 at the moment)
* Supports all the TWAIN functions in the spec
* Hosts internal message loop so no need to hook into application UI thread
 
The solution contains tester projects in winform, wpf, and even (gasp!) console. 
A nuget package is also [available here](https://www.nuget.org/packages/ntwain)

Using the lib
--------------------------------------
To properly use this lib you will need to be reasonably familiar with the TWAIN spec
and how it works in general. Except for certain "important" calls that drive the
TWAIN state change, most triplet operations are only availble as-is so you will need to know
when and how to use them. There are no high-level, single-line scan-a-page-for-me-now functions.

At the moment this lib does not provide ways to parse transferred image data and require
consumers to do the conversion. The winform project contains one such 
example for handling DIB image in native transfer.

The main class to use is TwainSession. New it up, hook into the events, and start calling
all the TWAIN functions provided through it.