DeviceWrapper.cs File Reference

The SDK interface of LibWebFXScan is used to develop the client application for C#. More...

Go to the source code of this file.

Classes
class	DeviceWrapper
	The DeviceWrapper class is a C# wrapper layer of LibWebFXScan. More...

Enumerations
enum	ENUM_LIBWFX_ERRCODE {   ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_SUCCESS = 0, ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_FAIL, ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_NO_INIT, ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_NO_RECOGNIZE_TOOL,   ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_NO_DEVICES, ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_FORMAT_ERROR, ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_NO_DEVICE_NAME, ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_NO_SOURCE,   ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_FILE_NO_EXIST, ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_PAPER_NOT_READY, ENUM_LIBWFX_ERRCODE.LIBWFX_ERRCODE_INVALID_SERIALNUM }
	The error code of LibWebFXScan. More...
enum	ENUM_LIBWFX_EVENT_CODE {   ENUM_LIBWFX_EVENT_CODE.LIBWFX_EVENT_PAPER_DETECTED = 0, ENUM_LIBWFX_EVENT_CODE.LIBWFX_EVENT_NO_PAPER, ENUM_LIBWFX_EVENT_CODE.LIBWFX_EVENT_PAPER_JAM, ENUM_LIBWFX_EVENT_CODE.LIBWFX_EVENT_MULTIFEED,   ENUM_LIBWFX_EVENT_CODE.LIBWFX_EVENT_NO_CALIBRATION_DATA, ENUM_LIBWFX_EVENT_CODE.LIBWFX_EVENT_WARMUP_COUNTDOWN }
	The feedback of event from LIBWFXEVENTCB callback function. More...
enum	ENUM_LIBWFX_EXCEPTION_CODE { ENUM_LIBWFX_EXCEPTION_CODE.LIBWFX_EXC_OTHER = 0, ENUM_LIBWFX_EXCEPTION_CODE.LIBWFX_EXC_TIFF_SAVE_FINSIHED, ENUM_LIBWFX_EXCEPTION_CODE.LIBWFX_EXC_PDF_SAVE_FINSIHED }
	If the feedback of exception from LIBWFXCB callback function and ENUM_LIBWFX_NOTIFY_CODE is ENUM_LIBWFX_NOTIFY_CODE::LIBWFX_NOTIFY_EXCEPTION, then pParam1 will return ENUM_LIBWFX_EXCEPTION_CODE type. More...
enum	ENUM_LIBWFX_NOTIFY_CODE { ENUM_LIBWFX_NOTIFY_CODE.LIBWFX_NOTIFY_IMAGE_DONE = 0, ENUM_LIBWFX_NOTIFY_CODE.LIBWFX_NOTIFY_END, ENUM_LIBWFX_NOTIFY_CODE.LIBWFX_NOTIFY_EXCEPTION }
	The feedback of notify from LIBWFXCB callback function after scanning. More...

Detailed Description

The SDK interface of LibWebFXScan is used to develop the client application for C#.

Date

2017-06-09

Author

Jack Chen

Copyright

Copyright (c) 2017 Adview, Inc. ALL Rights Reserved This source file is subject to the terms and conditions of the Adview Inc which restricts the manner in which it may be used.

Definition in file DeviceWrapper.cs.

Enumeration Type Documentation

ENUM_LIBWFX_ERRCODE

enum ENUM_LIBWFX_ERRCODE

strong

The error code of LibWebFXScan.

Enumerator
LIBWFX_ERRCODE_SUCCESS	The function is performed successfully
LIBWFX_ERRCODE_FAIL	The function performed to failure
LIBWFX_ERRCODE_NO_INIT	The SDK is not yet do initialize
LIBWFX_ERRCODE_NO_RECOGNIZE_TOOL	The SDK can not set OCR engine, please install OCR engine
LIBWFX_ERRCODE_NO_DEVICES	No devices are connecting
LIBWFX_ERRCODE_FORMAT_ERROR	The format of json string is invalid
LIBWFX_ERRCODE_NO_DEVICE_NAME	The json string command must include "device-name" item
LIBWFX_ERRCODE_NO_SOURCE	The json string command must include "source" item
LIBWFX_ERRCODE_FILE_NO_EXIST	The specified file name is not exist when removing files
LIBWFX_ERRCODE_PAPER_NOT_READY	The device is not detecting the paper
LIBWFX_ERRCODE_INVALID_SERIALNUM	The serial number is invalid, it will get fail when doing ocr recognize

Definition at line 19 of file DeviceWrapper.cs.

ENUM_LIBWFX_EVENT_CODE

enum ENUM_LIBWFX_EVENT_CODE

strong

The feedback of event from LIBWFXEVENTCB callback function.

Enumerator
LIBWFX_EVENT_PAPER_DETECTED	The event of paper detected
LIBWFX_EVENT_NO_PAPER	The event of no paper event, please feed the paper
LIBWFX_EVENT_PAPER_JAM	The event of paper jam, please check the device status
LIBWFX_EVENT_MULTIFEED	The event of multiple paper feed, please check device status
LIBWFX_EVENT_NO_CALIBRATION_DATA	The event of no calibration, please do calibration first
LIBWFX_EVENT_WARMUP_COUNTDOWN	The device should warmup before scanning, and user will get count down timer

Definition at line 37 of file DeviceWrapper.cs.

ENUM_LIBWFX_EXCEPTION_CODE

enum ENUM_LIBWFX_EXCEPTION_CODE

strong

If the feedback of exception from LIBWFXCB callback function and ENUM_LIBWFX_NOTIFY_CODE is ENUM_LIBWFX_NOTIFY_CODE::LIBWFX_NOTIFY_EXCEPTION, then pParam1 will return ENUM_LIBWFX_EXCEPTION_CODE type.

Enumerator
LIBWFX_EXC_OTHER	The pParam2 will return other exception code, e.g. "error:something's wrong(x)"
LIBWFX_EXC_TIFF_SAVE_FINSIHED	If the type of saving is pdf or multi-pdf, then LIBWFXCB will callback this expection code in pParam1 (pParam2 is the filename of pdf.)
LIBWFX_EXC_PDF_SAVE_FINSIHED	If the type of saving is tif or multi-tif, then LIBWFXCB will callback this expection code in pParam1 (pParam2 is the filename of tif.)

Definition at line 50 of file DeviceWrapper.cs.

ENUM_LIBWFX_NOTIFY_CODE

enum ENUM_LIBWFX_NOTIFY_CODE

strong

The feedback of notify from LIBWFXCB callback function after scanning.

Enumerator
LIBWFX_NOTIFY_IMAGE_DONE	One image save successfully in the specific storage path
LIBWFX_NOTIFY_END	All image processing have finished
LIBWFX_NOTIFY_EXCEPTION	Please reference ENUM_LIBWFX_EXCEPTION_CODE in pParam1, and pParam2 will get different value

Definition at line 60 of file DeviceWrapper.cs.