inkUSBAPI.h File Reference

#include <stdio.h>
#include <windows.h>
#include <tchar.h>
#include "ie_types.h"
#include "inkustr.h"
#include "ieusb_io.h"
#include "debugOpt.h"
#include "scrnsaverdef.h"
#include "usb_io.h"

Go to the source code of this file.

Namespaces

namespace  FIRMWARE
namespace  EPADPROFW

Classes

struct  EPADPROFW::PAD_DATA
struct  EPADPROFW::DATA_REPORT
struct  EPADPROFW::tagSERIAL_NUM_DATA
struct  EPADPROFW::SERIALNUM_REPORT
struct  EPADPROFW::ITO_GAIN
struct  EPADPROFW::ITO_LCD_CAL
struct  EPADPROFW::SYSCAL_DATA
struct  EPADPROFW::SYSCAL_REPORT
struct  EPADPROFW::DEFAULTS_DATA
struct  EPADPROFW::DEFAULTS_REPORT
struct  EPADPROFW::EEPROM_ADDR_DATA
struct  EPADPROFW::EEPROM_ADDR_REPORT
struct  EPADPROFW::DATA_ENCRYPTION_MODE_REPORT
struct  EPADPROFW::ONE_BYTE_RPT_DATA
struct  EPADPROFW::WRITE_EEPROM_REPORT
struct  EPADPROFW::PAD_INFO_DATA
struct  EPADPROFW::PAD_INFO_REPORT
struct  EPADPROFW::LCD_INFO
struct  EPADPROFW::LCD_INFO_REPORT
struct  EPADPROFW::LCD_POINT
struct  EPADPROFW::LCD_RGB
struct  EPADPROFW::DRAW_LINE_DATA
struct  EPADPROFW::DRAW_LINE_REPORT
struct  EPADPROFW::CLRSCRN_DATA
struct  EPADPROFW::CLRSCRN_REPORT
struct  EPADPROFW::BITMAP_DISP_PARM
struct  EPADPROFW::CREATE_BITMAP_DATA
struct  EPADPROFW::CREATE_BITMAP_REPORT
struct  EPADPROFW::IMGCOPY_DATA
struct  EPADPROFW::IMGCOPY_REPORT
struct  EPADPROFW::INK_REGION_DATA
struct  EPADPROFW::INK_REGION_REPORT
struct  EPADPROFW::tagBACKLIGHTINFO
struct  EPADPROFW::BACKLIGHT_INFO_REPORT
struct  EPADPROFW::FILE_DATA_CHUNK
struct  EPADPROFW::MAINTENANCE_PAYLOAD
struct  EPADPROFW::OPEN_SYS_FILE_REPORT
struct  EPADPROFW::READ_SYS_FILE_REPORT
struct  EPADPROFW::IEUS_MD5
struct  EPADPROFW::EXE_PARM_DATA
struct  EPADPROFW::EXECUTE_TMP_REPORT
struct  EPADPROFW::USER_PREFERENCES
union  EPADPROFW::PADDED_USER_PREFERENCES
struct  EPADPROFW::USER_PREFERENCES_REPORT
struct  EPADPROFW::tagPAD_PROCESSOR_INFO
struct  EPADPROFW::PAD_PROCESSOR_INFO_REPORT
struct  EPADPROFW::tagINK_ENABLE_INFO
struct  EPADPROFW::INK_ENABLE_REPORT
struct  EPADPROFW::WRITE_TEXT_INFO
struct  EPADPROFW::WRITE_TEXT_REPORT
class  USR_SCREENSAVER
struct  tagDATA_FLAGS
struct  RPTDATA

Defines

#define MAJOR_VERSION   1
#define MINOR_VERSION   11

Typedefs

typedef INT8U EPADPROFW::T_REPORT_ID
typedef struct EPADPROFW::PAD_DATA * EPADPROFW::PPAD_DATA
typedef struct EPADPROFW::DATA_REPORT * EPADPROFW::PDATA_REPORT
typedef EPADPROFW::tagSERIAL_NUM_DATA EPADPROFW::SERIAL_NUM_DATA
typedef EPADPROFW::tagSERIAL_NUM_DATA * EPADPROFW::PSERIAL_NUM_DATA
typedef struct EPADPROFW::SERIALNUM_REPORT * EPADPROFW::PSERIALNUM_REPORT
typedef struct EPADPROFW::ITO_GAIN * EPADPROFW::PITO_GAIN
typedef struct EPADPROFW::ITO_LCD_CAL * EPADPROFW::PITO_LCD_CAL
typedef struct EPADPROFW::SYSCAL_DATA * EPADPROFW::PSYSCAL_DATA
typedef struct EPADPROFW::SYSCAL_REPORT * EPADPROFW::PSYSCAL_REPORT
typedef struct EPADPROFW::DEFAULTS_DATA * EPADPROFW::PDEFAULTS_DATA
typedef struct EPADPROFW::DEFAULTS_REPORT * EPADPROFW::PDEFAULTS_REPORT
typedef struct EPADPROFW::EEPROM_ADDR_DATA * EPADPROFW::PEEPROM_ADDR_DATA
typedef struct EPADPROFW::EEPROM_ADDR_REPORT * EPADPROFW::PEEPROM_ADDR_REPORT
typedef struct EPADPROFW::DATA_ENCRYPTION_MODE_REPORT * EPADPROFW::PDATA_ENCRYPTION_MODE_REPORT
typedef struct EPADPROFW::ONE_BYTE_RPT_DATA * EPADPROFW::PONE_BYTE_RPT_DATA
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::PWRITE_EEPROM_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::READ_EEPROM_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::PREAD_EEPROM_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::SAVE_SETTINGS_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::PSAVE_SETTINGS_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::REPORT_RATE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::PREPORT_RATE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::DELETE_BITMAP_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::PDELETE_BITMAP_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::LCD_CONTRAST_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::PLCD_CONTRAST_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::CLR_INK_REGION_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::PCLR_INK_REGION_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::OPEN_PEM_FILE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::POPEN_PEM_FILE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::OPEN_TMP_FILE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::POPEN_TMP_FILE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::FILTER_TYPE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::PFILTER_TYPE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::ONE_BYTE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::PONE_BYTE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT EPADPROFW::UNUSED_PARAMETER_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT * EPADPROFW::PUNUSED_PARAMETER_REPORT
typedef struct EPADPROFW::PAD_INFO_DATA * EPADPROFW::PPAD_INFO_DATA
typedef struct EPADPROFW::PAD_INFO_REPORT * EPADPROFW::PPAD_INFO_REPORT
typedef INT8U EPADPROFW::TLCD_COLOR_CODE
typedef struct EPADPROFW::LCD_INFO * EPADPROFW::PLCD_INFO
typedef struct EPADPROFW::LCD_INFO_REPORT * EPADPROFW::PLCD_INFO_REPORT
typedef struct EPADPROFW::LCD_RGB * EPADPROFW::PLCD_RGB
typedef struct EPADPROFW::DRAW_LINE_DATA * EPADPROFW::PDRAW_LINE_DATA
typedef struct EPADPROFW::DRAW_LINE_REPORT * EPADPROFW::PDRAW_LINE_REPORT
typedef struct EPADPROFW::CLRSCRN_DATA * EPADPROFW::PCLRSCRN_DATA
typedef struct EPADPROFW::CLRSCRN_REPORT * EPADPROFW::PCLRSCRN_REPORT
typedef INT8U EPADPROFW::T_BITMAP_ID
typedef struct EPADPROFW::CREATE_BITMAP_DATA * EPADPROFW::PCREATE_BITMAP_DATA
typedef struct EPADPROFW::CREATE_BITMAP_REPORT * EPADPROFW::PCREATE_BITMAP_REPORT
typedef struct EPADPROFW::IMGCOPY_DATA * EPADPROFW::PIMGCOPY_DATA
typedef struct EPADPROFW::IMGCOPY_REPORT * EPADPROFW::PIMGCOPY_REPORT
typedef ON_OFF_AUTO EPADPROFW::ON_OFF
typedef struct EPADPROFW::INK_REGION_DATA * EPADPROFW::PINK_REGION_DATA
typedef struct EPADPROFW::INK_REGION_REPORT * EPADPROFW::PINK_REGION_REPORT
typedef EPADPROFW::tagBACKLIGHTINFO EPADPROFW::BACKLIGHT_INFO
typedef EPADPROFW::tagBACKLIGHTINFO * EPADPROFW::PBACKLIGHT_INFO
typedef struct EPADPROFW::BACKLIGHT_INFO_REPORT * EPADPROFW::PBACKLIGHT_INFO_REPORT
typedef struct EPADPROFW::FILE_DATA_CHUNK * EPADPROFW::PFILE_DATA_CHUNK
typedef struct EPADPROFW::MAINTENANCE_PAYLOAD * EPADPROFW::PMAINTENANCE_PAYLOAD
typedef struct EPADPROFW::OPEN_SYS_FILE_REPORT * EPADPROFW::POPEN_SYS_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT * EPADPROFW::PREAD_SYS_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT EPADPROFW::READ_PEM_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT * EPADPROFW::PREAD_PEM_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT EPADPROFW::READ_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT * EPADPROFW::PREAD_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT EPADPROFW::WRITE_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT * EPADPROFW::PWRITE_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT EPADPROFW::WRITE_EXEC_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT * EPADPROFW::PWRITE_EXEC_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT EPADPROFW::WRITE_CRYPTO_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT * EPADPROFW::PWRITE_CRYPTO_TMP_FILE_REPORT
typedef struct EPADPROFW::IEUS_MD5 * EPADPROFW::PIEUS_MD5
typedef struct EPADPROFW::EXECUTE_TMP_REPORT * EPADPROFW::PEXECUTE_TMP_REPORT
typedef struct EPADPROFW::USER_PREFERENCES * EPADPROFW::PUSER_PREFERENCES
typedef union EPADPROFW::PADDED_USER_PREFERENCES * EPADPROFW::PPADDED_USER_PREFERENCES
typedef struct EPADPROFW::USER_PREFERENCES_REPORT * EPADPROFW::PUSER_PREFERENCES_REPORT
typedef struct EPADPROFW::USER_PREFERENCES_REPORT EPADPROFW::USER_PREF
typedef struct EPADPROFW::USER_PREFERENCES_REPORT * EPADPROFW::PUSER_PREF
typedef EPADPROFW::tagPAD_PROCESSOR_INFO EPADPROFW::PAD_PROCESSOR_INFO
typedef EPADPROFW::tagPAD_PROCESSOR_INFO * EPADPROFW::PPAD_PROCESSOR_INFO
typedef struct EPADPROFW::PAD_PROCESSOR_INFO_REPORT * EPADPROFW::PPAD_PROCESSOR_INFO_REPORT
typedef EPADPROFW::tagINK_ENABLE_INFO EPADPROFW::INK_ENABLE_INFO
typedef EPADPROFW::tagINK_ENABLE_INFO * EPADPROFW::PINK_ENABLE_INFO
typedef struct EPADPROFW::INK_ENABLE_REPORT * EPADPROFW::PINK_ENABLE_REPORT
typedef struct EPADPROFW::WRITE_TEXT_INFO * EPADPROFW::PWRITE_TEXT_INFO
typedef struct EPADPROFW::WRITE_TEXT_REPORT * EPADPROFW::PWRITE_TEXT_REPORT
typedef void * INKUSB_CONTEXT
typedef void * INKUSB_DEVICE_CONTEXT
typedef HRESULT(* USR_CONFIG_HANDLER )(INKUSB_CONTEXT libContext, INKUSB_DEVICE_CONTEXT devContext)
typedef HRESULT(* USR_SETTINGS_HANDLER )(SETTINGS_OP operation, INKUSB_CONTEXT libContext, INKUSB_DEVICE_CONTEXT devContext, POPTIONS pOptions, PSYS_CAL pCal, PSCREENSAVER_INFO pScreenSaverInfo)
typedef void(* USR_DATA_READY_HOOK )(INKUSB_DEVICE_CONTEXT devContext, void *pUserDevContext)
typedef USR_SCREENSAVER * PUSR_SCREENSAVER
typedef tagDATA_FLAGS RPT_DATA_FLAGS
typedef tagDATA_FLAGS * PRPT_DATA_FLAGS
typedef RPTDATA * PRPTDATA

Enumerations

enum  EPADPROFW::REPORT_ID {
  EPADPROFW::R_DATA = 1, EPADPROFW::F_SERIAL, EPADPROFW::F_SYSCAL, EPADPROFW::F_DEFAULTS,
  EPADPROFW::F_EEPROMADDR, EPADPROFW::F_WRITEEPROM, EPADPROFW::F_READEEPROM, EPADPROFW::F_SAVESETTINGS,
  EPADPROFW::F_ENCRYPTION_MODE, EPADPROFW::F_REPORTRATE, EPADPROFW::F_PADINFO, EPADPROFW::F_LCDINFO,
  EPADPROFW::F_DRAWLINE, EPADPROFW::F_CLRSCRN, EPADPROFW::F_CREATE_BITMAP, EPADPROFW::F_DEL_BITMAP,
  EPADPROFW::F_IMAGE_COPY, EPADPROFW::F_CONTRAST, EPADPROFW::F_INK_REGION, EPADPROFW::F_CLR_INK_REGION,
  EPADPROFW::F_BACKLIGHT, EPADPROFW::F_OPEN_SYS_FILE, EPADPROFW::F_READ_SYS_FILE, EPADPROFW::F_OPEN_PEM_FILE,
  EPADPROFW::F_READ_PEM_FILE, EPADPROFW::F_OPEN_TMP_FILE, EPADPROFW::F_READ_TMP_FILE, EPADPROFW::F_WRITE_TMP_FILE,
  EPADPROFW::F_WRITE_EXEC_TMP_FILE, EPADPROFW::F_WRITE_CRYPTO_TMP_FILE, EPADPROFW::F_EXECUTE_TMP_FILE, EPADPROFW::F_USER_SETTINGS,
  EPADPROFW::F_FILTER, EPADPROFW::F_REBOOT, EPADPROFW::F_INK_ENABLE, EPADPROFW::F_PAD_PROC_INFO,
  EPADPROFW::F_TEXT
}
enum  EPADPROFW::ENCRYPTION_TYPE {
  EPADPROFW::ENCRYPTION_NONE = 0, EPADPROFW::ENCRYPTION_AES128_ECB, EPADPROFW::ENCRYPTION_AES192_ECB, EPADPROFW::ENCRYPTION_AES256_ECB,
  EPADPROFW::ENCRYPTION_DES64, EPADPROFW::ENCRYPTION_3DES192
}
enum  EPADPROFW::REPORT_RATE_CODE { EPADPROFW::RATE_100 = 1, EPADPROFW::RATE_200 = 2, EPADPROFW::RATE_300 = 3, EPADPROFW::RATE_400 = 4 }
enum  EPADPROFW::FILTER_TYPE {
  EPADPROFW::SG_FILTER_NONE, EPADPROFW::SG_FILTER_5_2, EPADPROFW::SG_FILTER_7_3, EPADPROFW::SG_FILTER_9_4,
  EPADPROFW::SG_FILTER_11_5, EPADPROFW::SG_FILTER_13_5
}
enum  EPADPROFW::LCD_COLOR_CODE { EPADPROFW::LCD_COLOR = 0, EPADPROFW::LCD_GRAYSCALE = 1, EPADPROFW::LCD_ALPHABLENDING = 2 }
enum  EPADPROFW::BITMAP_DISP_IMAGECOPY_OPERATION { EPADPROFW::DISP_COPY_IMAGE = 0, EPADPROFW::DISP_OR_IMAGE = 1, EPADPROFW::DISP_XOR_IMAGE = 2, EPADPROFW::DISP_AND_IMAGE = 3 }
enum  EPADPROFW::ON_OFF_AUTO { EPADPROFW::B_OFF = 0, EPADPROFW::B_ON = 1, EPADPROFW::B_AUTO = 2 }
enum  EPADPROFW::BRIGHTNESS { EPADPROFW::BL_DIM = 0, EPADPROFW::BL_BRIGHT = 1 }
enum  EPADPROFW::EXE_FILE_TYPES { EPADPROFW::EXEFILETYPE_JEFFERSON_EXE_FILE = 0, EPADPROFW::EXEFILETYPE_PEM_FILE = 1, EPADPROFW::EXEFILETYPE_BITMAP_FILE = 2 }
enum  EPADPROFW::SCREEN_SAVER_MODE { EPADPROFW::SCRN_SAVER_OFF = 0, EPADPROFW::SCRN_SAVER_BLANK, EPADPROFW::SCRN_SAVER_LINES }
enum  SETTINGS_OP { READ, WRITE }
enum  SCREEN_SAVER_STATE {
  SS_INITIALIZING, SS_IDLE, SS_ACTIVE, SS_WAIT_NO_DATA,
  SS_TERMINATED
}
enum  PARAM_KEY {
  OPT_VERSION, OPT_OPENCONFIG, OPT_WRITEREG, OPT_SUPPRESSBITMAP,
  OPT_RAWVALUES, OPT_SCREENSAVER, OPT_SCREENSAVER_TXT, OPT_SCREENSAVER_DEFAULT_IMG,
  OPT_REG_SAVER_TIMEOUT_KEY, OPT_CLOSETIMEOUT, OPT_LOGFILE, OPT_FLUSHLOG,
  OPT_LOGMSG, OPT_BITMAP_PATH, OPT_EXCLUSIVEOPEN, OPT_RUNNINGMODE,
  OPT_CLEARREGKEY, OPT_GETXML_OUTPUT, OPT_DEFAULT_BITMAP_INDEX_KEY, OPT_USERDEFINEPATH,
  OPT_EPADPROINUSE, OPT_GETINDEX_STRING = 128
}
enum  INKUSB_PARAM {
  PARAM_fDisplayDefaultBitmap = 0, PARAM_fTransformInkingArea, PARAM_fDisplayConfigDialog, PARAM_fSuppressbitmap,
  PARAM_fPopupConfigOnFirstUse
}

Functions

INKUSB_CONTEXT inkUSBCreateContext (USR_SETTINGS_HANDLER userSettingsHandler, USR_CONFIG_HANDLER userConfigHandler, void *pUserContext)
void * inkUSBGetUserContext (INKUSB_CONTEXT context)
HRESULT inkUSBDestroyContext (INKUSB_CONTEXT context)
HRESULT inkUSBGetScreenSaverInfo (INKUSB_CONTEXT hContext, PSCREENSAVER_INFO pInfo)
HRESULT inkUSBSetScreenSaverInfo (INKUSB_CONTEXT hContext, PSCREENSAVER_INFO pInfo)
HRESULT inkUSBConnResetDefaults (INKUSB_DEVICE_CONTEXT hContext)
HRESULT inkUSBConnClrScrn (INKUSB_DEVICE_CONTEXT hContext, INT8U layer, INT8U color)
HRESULT inkUSBConnSetSystemCal (INKUSB_DEVICE_CONTEXT hContext, SYS_CAL *pCal)
HRESULT inkUSBConnGetSystemCal (INKUSB_DEVICE_CONTEXT hContext, SYS_CAL *pCal)
HRESULT inkUSBConnSetOptions (INKUSB_DEVICE_CONTEXT hContext, OPTIONS *pOptions)
HRESULT inkUSBConnGetOptions (INKUSB_DEVICE_CONTEXT hContext, OPTIONS *pOptions)
HRESULT inkUSBConnDrawScreen (INKUSB_DEVICE_CONTEXT hContext, LCD_SCREEN *pScreen)
HRESULT inkUSBConnDrawLine (INKUSB_DEVICE_CONTEXT hContext, LCD_LAYER layer, PEN_COLOR color, LCD_POINT p1, LCD_POINT p2)
HRESULT inkUSBConnMouseEcho (INKUSB_DEVICE_CONTEXT hContext, INT8U bmButtons, INT8S dx, INT8S dy)
HRESULT inkUSBConnSelfTest (INKUSB_DEVICE_CONTEXT hContext, INT8U *pResultCode)
HRESULT inkUSBConnDrawBitmap (INKUSB_DEVICE_CONTEXT hContext, LCD_BITMAP *pBitmap)
HRESULT inkUSBConnSetLayer (INKUSB_DEVICE_CONTEXT hContext, INT8U layer, LAYER_CODE layerState)
HRESULT inkUSBConnGetLayer (INKUSB_DEVICE_CONTEXT hContext, INT8U layer, LAYER_CODE *pLayerState)
HRESULT inkUSBConnSetMixCode (INKUSB_DEVICE_CONTEXT hContext, MIX_CODE mixCode)
HRESULT inkUSBConnGetMixCode (INKUSB_DEVICE_CONTEXT hContext, MIX_CODE *pMixCode)
HRESULT inkUSBConnMapToLCD (INKUSB_DEVICE_CONTEXT hContext, int *p_LCD_x, int *p_LCD_y, int *p_absX, int *p_absY)
HRESULT inkUSBDbgGetDeviceHandle (INKUSB_DEVICE_CONTEXT hContext, HANDLE *pHandle)
HRESULT inkUSBDbgSetDebugParam (INKUSB_CONTEXT hContext, INKUSB_DEVICE_CONTEXT hDeviceContext, PARAM_KEY key, _TCHAR *pBuffer, DWORD dwLength)
HRESULT inkUSBDbgGetDebugParam (INKUSB_CONTEXT hContext, INKUSB_DEVICE_CONTEXT hDeviceContext, PARAM_KEY key, _TCHAR *pBuffer, size_t outBufferLength, DWORD *p_dwLength)
HRESULT inkUSBGetParamKey (_TCHAR *inStr, PARAM_KEY *key)
HRESULT inkUSBePadGetNumDevices (INKUSB_CONTEXT hContext, INT *p_iNumDevices)
HRESULT inkUSBintOpenConnection (INKUSB_DEVICE_CONTEXT pContext, INT iDeviceNum, BOOL fSetupDevice=TRUE)
INKUSB_DEVICE_CONTEXT inkUSBePadOpenConnection (INKUSB_CONTEXT context, INT iDeviceNum, void *pUserContext, PUSR_SCREENSAVER UserScreenSaver, USR_DATA_READY_HOOK userDataNotifyReady)
USR_DATA_READY_HOOK inkUSBePadSetDataHook (INKUSB_DEVICE_CONTEXT context, USR_DATA_READY_HOOK userDataNotifyReady, void *pUserContext)
void * inkUSBePadGetUserContext (INKUSB_DEVICE_CONTEXT context)
IEUSB_HANDLE inkUSBePadGetDeviceHandle (INKUSB_DEVICE_CONTEXT context)
HRESULT inkUSBePadCloseConnection (INKUSB_DEVICE_CONTEXT hContext)
HRESULT inkUSBePadConnGetRanges (INKUSB_DEVICE_CONTEXT hContext, INT *p_min_x, INT *p_max_x, INT *p_min_y, INT *p_max_y, INT *p_min_press, INT *p_max_press, INT *p_nButtons)
HRESULT inkUSBePadConnSetMouseOn (INKUSB_DEVICE_CONTEXT hContext, CHAR fState)
HRESULT inkUSBePadConnGetMouseOn (INKUSB_DEVICE_CONTEXT hContext, CHAR *p_fState)
HRESULT inkUSBePadConnGetSerialNumber (INKUSB_DEVICE_CONTEXT hContext, GUID *p_serialNum)
HRESULT inkUSBePadConnPushMouseData (INKUSB_DEVICE_CONTEXT hContext, BYTE dx, BYTE dy, CHAR bmButtons)
HRESULT inkUSBePadConnGetPhysicalExtents (INKUSB_DEVICE_CONTEXT hContext, double *pExtX, double *pExtY)
HRESULT inkUSBePadConnGetReportRate (INKUSB_DEVICE_CONTEXT hContext, INT *p_nPackets, INT *p_milliseconds)
HRESULT inkUSBePadGetSerialNumber (INKUSB_CONTEXT context, int iDeviceNum, GUID *p_serialNum)
HRESULT inkUSBintConnClrScrn (INKUSB_DEVICE_CONTEXT hContext, INT8U layer, INT8U color, BOOL fIsDataThread)
HRESULT inkUSBintConnDrawBitmap (INKUSB_DEVICE_CONTEXT hContext, LCD_BITMAP *pBitmap, BOOL fIsDataThread)
HRESULT inkUSBintConnDrawLine (INKUSB_DEVICE_CONTEXT hContext, LCD_LAYER layer, PEN_COLOR color, LCD_POINT p1, LCD_POINT p2, BOOL fIsDataThread)
HRESULT inkUSBDevReadReport (INKUSB_DEVICE_CONTEXT hContext, void *pFormattedReport, INT16U *p_Length)
HRESULT inkUSBDevReadReport (INKUSB_DEVICE_CONTEXT hContext, FIRMWARE::REPORT_ID id, void *pBuffer, INT16U *p_Length)
HRESULT inkUSBDevWriteReport (INKUSB_DEVICE_CONTEXT hContext, void *pFormattedReport, INT16U *p_Length)
HRESULT inkUSBDevWriteReport (INKUSB_DEVICE_CONTEXT hContext, FIRMWARE::REPORT_ID id, void *pBuffer, INT16U *p_Length, BOOL fIsDataThread=FALSE)
BOOLEAN inkUSBDevReadFile (INKUSB_DEVICE_CONTEXT devContext, LPVOID lpBuffer, DWORD nNumberOfBytesToRead, LPDWORD lpNumberOfBytesRead, LPOVERLAPPED lpOverlapped)
BOOLEAN inkUSBDevGetOverlappedResult (INKUSB_DEVICE_CONTEXT devContext, LPOVERLAPPED lpOverlapped, LPDWORD lpNumberOfBytesTransferred, BOOL bWait)
BOOLEAN inkUSBDevCancelIo (INKUSB_DEVICE_CONTEXT devContext)
HRESULT inkUSBDevConnSetLayer (INKUSB_DEVICE_CONTEXT hContext, INT8U layer, LAYER_CODE layerState)
HRESULT inkUSBDevConnClrScrn (INKUSB_DEVICE_CONTEXT hContext, INT8U layer, INT8U color)
HRESULT inkUSBDevConnDrawBitmap (INKUSB_DEVICE_CONTEXT hContext, LCD_BITMAP *pBitmap)
HRESULT inkUSBConnGetDataReport (INKUSB_DEVICE_CONTEXT hContext, PRPTDATA pReport, DWORD *p_dwTimestamp)
HRESULT inkUSBDevSetDebugFile (INKUSB_DEVICE_CONTEXT hDevContext, FILE *hFile)
HRESULT inkUSBSetDebugFile (INKUSB_CONTEXT hLibContext, FILE *hFile)
HRESULT inkUSBDevGetCachedOptions (INKUSB_DEVICE_CONTEXT hDevContext, FIRMWARE::POPTIONS pOptions)
HRESULT inkUSBDevGetCachedCal (INKUSB_DEVICE_CONTEXT hDevContext, FIRMWARE::PSYS_CAL pSysCal)
HRESULT inkUSBLibGetParam (INKUSB_CONTEXT hLibContext, INKUSB_PARAM key, INT32U *pValue)
HRESULT inkUSBLibSetParam (INKUSB_CONTEXT hLibContext, INKUSB_PARAM key, INT32U value)
HRESULT inkUSBDevGetParam (INKUSB_DEVICE_CONTEXT hDevContext, INKUSB_PARAM key, INT32U *pValue)
HRESULT inkUSBDevSetParam (INKUSB_DEVICE_CONTEXT hDevContext, INKUSB_PARAM key, INT32U value)
HRESULT inkUSBDevTerminateScreenSaverThread (INKUSB_DEVICE_CONTEXT hDevContext)
HRESULT inkUSBDevRestartScreenSaverThread (INKUSB_DEVICE_CONTEXT hDevContext)
HRESULT inkUSBDevCheckUserScreenSaverThreadTerminated (INKUSB_DEVICE_CONTEXT hDevContext, BOOL &retVal)
HRESULT inkUSBWaitForMultEventsOrUserScreenSaverThreadTerminated (INKUSB_DEVICE_CONTEXT hDevContext, const DWORD eventCount, const HANDLE eventArray[], const DWORD timeout, BOOL &abortFlag, DWORD &index)
HRESULT inkUSBShowConfig (INKUSB_DEVICE_CONTEXT hDevContext)
HRESULT inkUSBePadProInUse (INKUSB_DEVICE_CONTEXT hDevContext)
HRESULT inkUSBConnSaveSettings (INKUSB_DEVICE_CONTEXT hDevContext)
HRESULT inkdoCombineLayers (INKUSB_DEVICE_CONTEXT hDevContext, int layer)

Define Documentation

#define MAJOR_VERSION   1
 

Definition at line 170 of file inkUSBAPI.h.

#define MINOR_VERSION   11
 

Definition at line 171 of file inkUSBAPI.h.

Typedef Documentation

typedef void* INKUSB_CONTEXT
 

Definition at line 35 of file inkUSBAPI.h.

typedef void* INKUSB_DEVICE_CONTEXT
 

Definition at line 36 of file inkUSBAPI.h.

typedef struct tagDATA_FLAGS * PRPT_DATA_FLAGS
 

typedef struct RPTDATA * PRPTDATA
 

See also:
gIIEPadEvent::HandlePadData

typedef USR_SCREENSAVER* PUSR_SCREENSAVER
 

Definition at line 114 of file inkUSBAPI.h.

typedef struct tagDATA_FLAGS RPT_DATA_FLAGS
 

typedef HRESULT(* USR_CONFIG_HANDLER)(INKUSB_CONTEXT libContext, INKUSB_DEVICE_CONTEXT devContext)
 

This routine will handle device configuration on first-time open if OPEN_CONFIG is true when the device is opened for the first time on the system.

If the routine returns an error condition (FAILED(x)) then the open routine will fail the open call.

Returns:
HRESULT -- failure indicates that open operation should fail.
See also:
inkUSBePadOpenConnection

Definition at line 48 of file inkUSBAPI.h.

typedef void(* USR_DATA_READY_HOOK)(INKUSB_DEVICE_CONTEXT devContext, void *pUserDevContext)
 

Definition at line 63 of file inkUSBAPI.h.

typedef HRESULT(* USR_SETTINGS_HANDLER)(SETTINGS_OP operation, INKUSB_CONTEXT libContext, INKUSB_DEVICE_CONTEXT devContext, POPTIONS pOptions, PSYS_CAL pCal, PSCREENSAVER_INFO pScreenSaverInfo)
 

Used during opening of connection to attempt to read/write device settings to persistent media.

Definition at line 57 of file inkUSBAPI.h.

Enumeration Type Documentation

enum INKUSB_PARAM
 

Enumerator:
PARAM_fDisplayDefaultBitmap 
PARAM_fTransformInkingArea 
PARAM_fDisplayConfigDialog 
PARAM_fSuppressbitmap 
PARAM_fPopupConfigOnFirstUse 

Definition at line 272 of file inkUSBAPI.h.

00272              {
00273     PARAM_fDisplayDefaultBitmap = 0,
00274     PARAM_fTransformInkingArea,
00275     PARAM_fDisplayConfigDialog,
00276     PARAM_fSuppressbitmap,
00277     PARAM_fPopupConfigOnFirstUse
00278 } INKUSB_PARAM;

enum PARAM_KEY
 

Enumerator:
OPT_VERSION 
OPT_OPENCONFIG 
OPT_WRITEREG 
OPT_SUPPRESSBITMAP 
OPT_RAWVALUES 
OPT_SCREENSAVER 
OPT_SCREENSAVER_TXT 
OPT_SCREENSAVER_DEFAULT_IMG 
OPT_REG_SAVER_TIMEOUT_KEY 
OPT_CLOSETIMEOUT 
OPT_LOGFILE 
OPT_FLUSHLOG 
OPT_LOGMSG 
OPT_BITMAP_PATH 
OPT_EXCLUSIVEOPEN 
OPT_RUNNINGMODE 
OPT_CLEARREGKEY 
OPT_GETXML_OUTPUT 
OPT_DEFAULT_BITMAP_INDEX_KEY 
OPT_USERDEFINEPATH 
OPT_EPADPROINUSE 
OPT_GETINDEX_STRING 

Definition at line 174 of file inkUSBAPI.h.

00174              {
00175     OPT_VERSION,
00176     OPT_OPENCONFIG,
00177     OPT_WRITEREG,
00178     OPT_SUPPRESSBITMAP,
00179     OPT_RAWVALUES,
00180     OPT_SCREENSAVER,
00181     OPT_SCREENSAVER_TXT,
00182     OPT_SCREENSAVER_DEFAULT_IMG,
00183     OPT_REG_SAVER_TIMEOUT_KEY,
00184     OPT_CLOSETIMEOUT,
00185     OPT_LOGFILE,
00186     OPT_FLUSHLOG,
00187     OPT_LOGMSG,
00188     OPT_BITMAP_PATH,
00189     OPT_EXCLUSIVEOPEN,
00190     OPT_RUNNINGMODE,
00191     OPT_CLEARREGKEY,
00192     OPT_GETXML_OUTPUT,
00193     OPT_DEFAULT_BITMAP_INDEX_KEY,
00194     OPT_USERDEFINEPATH,
00195     OPT_EPADPROINUSE,
00196     OPT_GETINDEX_STRING = 128
00197 } PARAM_KEY;

enum SCREEN_SAVER_STATE