LibWebFXScan.h
Go to the documentation of this file.
1 
11 #pragma once
12 
13 #ifdef WIN32
14  #define LIBWFX_API __stdcall
15 #else
16  #define LIBWFX_API
17 #endif
18 
19 #define LIBWFX_DLLNAME _T("LibWebFXScan.dll")
20 
21 #define LIBWFX_API_INIT "LibWFX_Init"
22 #define LIBWFX_API_DEINIT "LibWFX_DeInit"
23 #define LIBWFX_API_GET_DEVICESLIST "LibWFX_GetDeviesList"
24 #define LIBWFX_API_GET_FILELIST "LibWFX_GetFileList"
25 #define LIBWFX_API_REMOVE_FILE "LibWFX_RemoveFile"
26 #define LIBWFX_API_SET_PROPERTY "LibWFX_SetProperty"
27 #define LIBWFX_API_START_SCAN "LibWFX_StartScan"
28 #define LIBWFX_API_CALIBRATE "LibWFX_Calibrate"
29 #define LIBWFX_API_ECOCONTROL "LibWFX_ECOControl"
30 #define LIBWFX_API_PAPER_READY "LibWFX_PaperReady"
31 #define LIBWFX_API_CLOSE_DEVICE "LibWFX_CloseDevice"
36 typedef enum _ENUM_LIBWFX_ERRCODE
37 {
50 
55 {
63 
68 {
73 
78 {
83 
92 typedef void (*LIBWFXEVENTCB)(ENUM_LIBWFX_EVENT_CODE enEventCode, int nParam, void* pUserDef);
93 
105 typedef void (*LIBWFXCB)(ENUM_LIBWFX_NOTIFY_CODE enNotifyCode, void* pUserDef, void* pParam1, void* pParam2);
106 
117 
128 
139 typedef ENUM_LIBWFX_ERRCODE (LIBWFX_API* LIBWFX_GETDEVICESLIST)(const char** szDevicesListOut);
140 
151 typedef ENUM_LIBWFX_ERRCODE (LIBWFX_API* LIBWFX_GETFILELIST)(const char** szFileListOut);
152 
163 typedef ENUM_LIBWFX_ERRCODE (LIBWFX_API* LIBWFX_REMOVEFILE)(char* szFileNameIn);
164 
177 typedef ENUM_LIBWFX_ERRCODE (LIBWFX_API* LIBWFX_SETPROPERTY)(char* szRequestCmdIn, LIBWFXEVENTCB pfnLibWFXEVENTCBIn, void* pUserDefIn);
178 
190 typedef ENUM_LIBWFX_ERRCODE (LIBWFX_API* LIBWFX_STARTSCAN)(LIBWFXCB pfnLibWFXCBIn, void* pUserDefIn);
191 
202 
214 typedef ENUM_LIBWFX_ERRCODE (LIBWFX_API* LIBWFX_ECOCONTROL)(unsigned long* pulTime, int nSetIn);
215 
226 
237 
#define LIBWFX_API
Definition: LibWebFXScan.h:16
ENUM_LIBWFX_NOTIFY_CODE
The feedback of notify from LIBWFXCB callback function after scanning.
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_PAPERREADY)(void)
To check whether the device feed the paper.
Definition: LibWebFXScan.h:225
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_STARTSCAN)(LIBWFXCB pfnLibWFXCBIn, void *pUserDefIn)
To start do scan.
Definition: LibWebFXScan.h:190
enum _ENUM_LIBWFX_NOTIFY_CODE ENUM_LIBWFX_NOTIFY_CODE
The feedback of notify from LIBWFXCB callback function after scanning.
_ENUM_LIBWFX_EXCEPTION_CODE
If the feedback of exception from LIBWFXCB callback function and _ENUM_LIBWFX_NOTIFY_CODE is ...
Definition: LibWebFXScan.h:67
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_INIT)(void)
Init the LibWebFXScan SDK .
Definition: LibWebFXScan.h:116
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_REMOVEFILE)(char *szFileNameIn)
Remove the specified file by filename, e.g. "IMG_1.jpg", "*"(delete all file)
Definition: LibWebFXScan.h:163
void(* LIBWFXEVENTCB)(ENUM_LIBWFX_EVENT_CODE enEventCode, int nParam, void *pUserDef)
The LIBWFXEVENTCB() type defines a pointer to this callback function. LIBWFX_SETPROPERTY() is a place...
Definition: LibWebFXScan.h:92
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_DEINIT)(void)
Deinit the LibWebFXScan SDK .
Definition: LibWebFXScan.h:127
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_ECOCONTROL)(unsigned long *pulTime, int nSetIn)
To set or get ECO time.
Definition: LibWebFXScan.h:214
_ENUM_LIBWFX_EVENT_CODE
The feedback of event from LIBWFXEVENTCB callback function.
Definition: LibWebFXScan.h:54
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_GETFILELIST)(const char **szFileListOut)
Get the imagefile list, but no including tif and pdf.
Definition: LibWebFXScan.h:151
enum _ENUM_LIBWFX_EXCEPTION_CODE ENUM_LIBWFX_EXCEPTION_CODE
If the feedback of exception from LIBWFXCB callback function and _ENUM_LIBWFX_NOTIFY_CODE is ...
ENUM_LIBWFX_EVENT_CODE
The feedback of event from LIBWFXEVENTCB callback function.
enum _ENUM_LIBWFX_ERRCODE ENUM_LIBWFX_ERRCODE
The error code of LibWebFXScan.
enum _ENUM_LIBWFX_EVENT_CODE ENUM_LIBWFX_EVENT_CODE
The feedback of event from LIBWFXEVENTCB callback function.
_ENUM_LIBWFX_NOTIFY_CODE
The feedback of notify from LIBWFXCB callback function after scanning.
Definition: LibWebFXScan.h:77
void(* LIBWFXCB)(ENUM_LIBWFX_NOTIFY_CODE enNotifyCode, void *pUserDef, void *pParam1, void *pParam2)
The LIBWFXCB() type defines a pointer to this callback function. LIBWFX_STARTSCAN() is a placeholder ...
Definition: LibWebFXScan.h:105
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_CALIBRATE)(void)
To do calibrate.
Definition: LibWebFXScan.h:201
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_SETPROPERTY)(char *szRequestCmdIn, LIBWFXEVENTCB pfnLibWFXEVENTCBIn, void *pUserDefIn)
Set the property of SDK, LibWebFXScan must do LIBWFX_SETPROPERTY before LIBWFX_STARTSCAN.
Definition: LibWebFXScan.h:177
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_CLOSEDEVICE)(void)
To close device currently.
Definition: LibWebFXScan.h:236
ENUM_LIBWFX_ERRCODE(LIBWFX_API * LIBWFX_GETDEVICESLIST)(const char **szDevicesListOut)
Get devices list.
Definition: LibWebFXScan.h:139