inkUSBAPI.h File Reference


Namespaces
namespace	FIRMWARE
namespace	EPADPROFW
Classes
struct	PAD_DATA
struct	DATA_REPORT
struct	tagSERIAL_NUM_DATA
struct	SERIALNUM_REPORT
struct	ITO_GAIN
struct	ITO_LCD_CAL
struct	SYSCAL_DATA
struct	SYSCAL_REPORT
struct	DEFAULTS_DATA
struct	DEFAULTS_REPORT
struct	EEPROM_ADDR_DATA
struct	EEPROM_ADDR_REPORT
struct	DATA_ENCRYPTION_MODE_REPORT
struct	ONE_BYTE_RPT_DATA
struct	WRITE_EEPROM_REPORT
struct	PAD_INFO_DATA
struct	PAD_INFO_REPORT
struct	LCD_INFO
struct	LCD_INFO_REPORT
struct	LCD_POINT
struct	LCD_RGB
struct	DRAW_LINE_DATA
struct	DRAW_LINE_REPORT
struct	CLRSCRN_DATA
struct	CLRSCRN_REPORT
struct	BITMAP_DISP_PARM
struct	CREATE_BITMAP_DATA
struct	CREATE_BITMAP_REPORT
struct	IMGCOPY_DATA
struct	IMGCOPY_REPORT
struct	INK_REGION_DATA
struct	INK_REGION_REPORT
struct	tagBACKLIGHTINFO
struct	BACKLIGHT_INFO_REPORT
struct	FILE_DATA_CHUNK
struct	MAINTENANCE_PAYLOAD
struct	OPEN_SYS_FILE_REPORT
struct	READ_SYS_FILE_REPORT
struct	IEUS_MD5
struct	EXE_PARM_DATA
struct	EXECUTE_TMP_REPORT
struct	USER_PREFERENCES
union	PADDED_USER_PREFERENCES
struct	USER_PREFERENCES_REPORT
struct	tagPAD_PROCESSOR_INFO
struct	PAD_PROCESSOR_INFO_REPORT
struct	tagINK_ENABLE_INFO
struct	INK_ENABLE_REPORT
struct	WRITE_TEXT_INFO
struct	WRITE_TEXT_REPORT
class	USR_SCREENSAVER
struct	tagDATA_FLAGS
struct	RPTDATA
Defines
#define	MAJOR_VERSION 1
#define	MINOR_VERSION 11
Typedefs
typedef INT8U	T_REPORT_ID
typedef struct EPADPROFW::PAD_DATA *	PPAD_DATA
typedef struct EPADPROFW::DATA_REPORT *	PDATA_REPORT
typedef struct EPADPROFW::tagSERIAL_NUM_DATA	SERIAL_NUM_DATA
typedef struct EPADPROFW::tagSERIAL_NUM_DATA *	PSERIAL_NUM_DATA
typedef struct EPADPROFW::SERIALNUM_REPORT *	PSERIALNUM_REPORT
typedef struct EPADPROFW::ITO_GAIN *	PITO_GAIN
typedef struct EPADPROFW::ITO_LCD_CAL *	PITO_LCD_CAL
typedef struct EPADPROFW::SYSCAL_DATA *	PSYSCAL_DATA
typedef struct EPADPROFW::SYSCAL_REPORT *	PSYSCAL_REPORT
typedef struct EPADPROFW::DEFAULTS_DATA *	PDEFAULTS_DATA
typedef struct EPADPROFW::DEFAULTS_REPORT *	PDEFAULTS_REPORT
typedef struct EPADPROFW::EEPROM_ADDR_DATA *	PEEPROM_ADDR_DATA
typedef struct EPADPROFW::EEPROM_ADDR_REPORT *	PEEPROM_ADDR_REPORT
typedef struct EPADPROFW::DATA_ENCRYPTION_MODE_REPORT *	PDATA_ENCRYPTION_MODE_REPORT
typedef struct EPADPROFW::ONE_BYTE_RPT_DATA *	PONE_BYTE_RPT_DATA
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	PWRITE_EEPROM_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	READ_EEPROM_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	PREAD_EEPROM_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	SAVE_SETTINGS_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	PSAVE_SETTINGS_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	REPORT_RATE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	PREPORT_RATE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	DELETE_BITMAP_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	PDELETE_BITMAP_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	LCD_CONTRAST_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	PLCD_CONTRAST_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	CLR_INK_REGION_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	PCLR_INK_REGION_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	OPEN_PEM_FILE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	POPEN_PEM_FILE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	OPEN_TMP_FILE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	POPEN_TMP_FILE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	FILTER_TYPE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	PFILTER_TYPE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	ONE_BYTE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	PONE_BYTE_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT	UNUSED_PARAMETER_REPORT
typedef struct EPADPROFW::WRITE_EEPROM_REPORT *	PUNUSED_PARAMETER_REPORT
typedef struct EPADPROFW::PAD_INFO_DATA *	PPAD_INFO_DATA
typedef struct EPADPROFW::PAD_INFO_REPORT *	PPAD_INFO_REPORT
typedef INT8U	TLCD_COLOR_CODE
typedef struct EPADPROFW::LCD_INFO *	PLCD_INFO
typedef struct EPADPROFW::LCD_INFO_REPORT *	PLCD_INFO_REPORT
typedef struct EPADPROFW::LCD_RGB *	PLCD_RGB
typedef struct EPADPROFW::DRAW_LINE_DATA *	PDRAW_LINE_DATA
typedef struct EPADPROFW::DRAW_LINE_REPORT *	PDRAW_LINE_REPORT
typedef struct EPADPROFW::CLRSCRN_DATA *	PCLRSCRN_DATA
typedef struct EPADPROFW::CLRSCRN_REPORT *	PCLRSCRN_REPORT
typedef INT8U	T_BITMAP_ID
typedef struct EPADPROFW::CREATE_BITMAP_DATA *	PCREATE_BITMAP_DATA
typedef struct EPADPROFW::CREATE_BITMAP_REPORT *	PCREATE_BITMAP_REPORT
typedef struct EPADPROFW::IMGCOPY_DATA *	PIMGCOPY_DATA
typedef struct EPADPROFW::IMGCOPY_REPORT *	PIMGCOPY_REPORT
typedef ON_OFF_AUTO	ON_OFF
typedef struct EPADPROFW::INK_REGION_DATA *	PINK_REGION_DATA
typedef struct EPADPROFW::INK_REGION_REPORT *	PINK_REGION_REPORT
typedef struct EPADPROFW::tagBACKLIGHTINFO	BACKLIGHT_INFO
typedef struct EPADPROFW::tagBACKLIGHTINFO *	PBACKLIGHT_INFO
typedef struct EPADPROFW::BACKLIGHT_INFO_REPORT *	PBACKLIGHT_INFO_REPORT
typedef struct EPADPROFW::FILE_DATA_CHUNK *	PFILE_DATA_CHUNK
typedef struct EPADPROFW::MAINTENANCE_PAYLOAD *	PMAINTENANCE_PAYLOAD
typedef struct EPADPROFW::OPEN_SYS_FILE_REPORT *	POPEN_SYS_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT *	PREAD_SYS_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT	READ_PEM_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT *	PREAD_PEM_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT	READ_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT *	PREAD_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT	WRITE_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT *	PWRITE_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT	WRITE_EXEC_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT *	PWRITE_EXEC_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT	WRITE_CRYPTO_TMP_FILE_REPORT
typedef struct EPADPROFW::READ_SYS_FILE_REPORT *	PWRITE_CRYPTO_TMP_FILE_REPORT
typedef struct EPADPROFW::IEUS_MD5 *	PIEUS_MD5
typedef struct EPADPROFW::EXECUTE_TMP_REPORT *	PEXECUTE_TMP_REPORT
typedef struct EPADPROFW::USER_PREFERENCES *	PUSER_PREFERENCES
typedef union EPADPROFW::PADDED_USER_PREFERENCES *	PPADDED_USER_PREFERENCES
typedef struct EPADPROFW::USER_PREFERENCES_REPORT *	PUSER_PREFERENCES_REPORT
typedef struct EPADPROFW::USER_PREFERENCES_REPORT	USER_PREF
typedef struct EPADPROFW::USER_PREFERENCES_REPORT *	PUSER_PREF
typedef struct EPADPROFW::tagPAD_PROCESSOR_INFO	PAD_PROCESSOR_INFO
typedef struct EPADPROFW::tagPAD_PROCESSOR_INFO *	PPAD_PROCESSOR_INFO
typedef struct EPADPROFW::PAD_PROCESSOR_INFO_REPORT *	PPAD_PROCESSOR_INFO_REPORT
typedef struct EPADPROFW::tagINK_ENABLE_INFO	INK_ENABLE_INFO
typedef struct EPADPROFW::tagINK_ENABLE_INFO *	PINK_ENABLE_INFO
typedef struct EPADPROFW::INK_ENABLE_REPORT *	PINK_ENABLE_REPORT
typedef struct EPADPROFW::WRITE_TEXT_INFO *	PWRITE_TEXT_INFO
typedef struct EPADPROFW::WRITE_TEXT_REPORT *	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 struct tagDATA_FLAGS	RPT_DATA_FLAGS
typedef struct tagDATA_FLAGS *	PRPT_DATA_FLAGS
typedef struct RPTDATA *	PRPTDATA
Enumerations
enum	REPORT_ID { R_DATA = 1, F_SERIAL, F_SYSCAL, F_DEFAULTS, F_EEPROMADDR, F_WRITEEPROM, F_READEEPROM, F_SAVESETTINGS, F_ENCRYPTION_MODE, F_REPORTRATE, F_PADINFO, F_LCDINFO, F_DRAWLINE, F_CLRSCRN, F_CREATE_BITMAP, F_DEL_BITMAP, F_IMAGE_COPY, F_CONTRAST, F_INK_REGION, F_CLR_INK_REGION, F_BACKLIGHT, F_OPEN_SYS_FILE, F_READ_SYS_FILE, F_OPEN_PEM_FILE, F_READ_PEM_FILE, F_OPEN_TMP_FILE, F_READ_TMP_FILE, F_WRITE_TMP_FILE, F_WRITE_EXEC_TMP_FILE, F_WRITE_CRYPTO_TMP_FILE, F_EXECUTE_TMP_FILE, F_USER_SETTINGS, F_FILTER, F_REBOOT, F_INK_ENABLE, F_PAD_PROC_INFO, F_TEXT }
enum	ENCRYPTION_TYPE { ENCRYPTION_NONE = 0, ENCRYPTION_AES128_ECB, ENCRYPTION_AES192_ECB, ENCRYPTION_AES256_ECB, ENCRYPTION_DES64, ENCRYPTION_3DES192 }
enum	REPORT_RATE_CODE { RATE_100 = 1, RATE_200 = 2, RATE_300 = 3, RATE_400 = 4 }
enum	FILTER_TYPE { SG_FILTER_NONE, SG_FILTER_5_2, SG_FILTER_7_3, SG_FILTER_9_4, SG_FILTER_11_5, SG_FILTER_13_5 }
enum	LCD_COLOR_CODE { LCD_COLOR = 0, LCD_GRAYSCALE = 1, LCD_ALPHABLENDING = 2 }
enum	BITMAP_DISP_IMAGECOPY_OPERATION { DISP_COPY_IMAGE = 0, DISP_OR_IMAGE = 1, DISP_XOR_IMAGE = 2, DISP_AND_IMAGE = 3 }
enum	ON_OFF_AUTO { B_OFF = 0, B_ON = 1, B_AUTO = 2 }
enum	BRIGHTNESS { BL_DIM = 0, BL_BRIGHT = 1 }
enum	EXE_FILE_TYPES { EXEFILETYPE_JEFFERSON_EXE_FILE = 0, EXEFILETYPE_PEM_FILE = 1, EXEFILETYPE_BITMAP_FILE = 2 }
enum	SCREEN_SAVER_MODE { SCRN_SAVER_OFF = 0, SCRN_SAVER_BLANK, 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)
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

#define MINOR_VERSION 11

Typedef Documentation

typedef void* INKUSB_CONTEXT

typedef void* INKUSB_DEVICE_CONTEXT

typedef struct tagDATA_FLAGS * PRPT_DATA_FLAGS

typedef struct RPTDATA * PRPTDATA

typedef USR_SCREENSAVER* PUSR_SCREENSAVER

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

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

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.

Enumeration Type Documentation

enum INKUSB_PARAM

Enumerator:

PARAM_fDisplayDefaultBitmap
PARAM_fTransformInkingArea
PARAM_fDisplayConfigDialog
PARAM_fSuppressbitmap
PARAM_fPopupConfigOnFirstUse

00271              {
00272     PARAM_fDisplayDefaultBitmap = 0,
00273     PARAM_fTransformInkingArea,
00274     PARAM_fDisplayConfigDialog,
00275     PARAM_fSuppressbitmap,
00276     PARAM_fPopupConfigOnFirstUse
00277 } 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

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

Enumerator:

SS_INITIALIZING
SS_IDLE
SS_ACTIVE
SS_WAIT_NO_DATA
SS_TERMINATED

00065              {
00066     SS_INITIALIZING,    // Initialization in process
00067     SS_IDLE,            // Normal user display
00068     SS_ACTIVE,          // user-defined screen saver
00069     SS_WAIT_NO_DATA,    // Exited, waiting for no data
00070     SS_TERMINATED       // Note that bad startups immediately terminate.
00071 } SCREEN_SAVER_STATE;

enum SETTINGS_OP

Enumerator:

READ
WRITE

00050              {
00051     READ, WRITE
00052 } SETTINGS_OP;

Function Documentation

HRESULT inkdoCombineLayers	(	INKUSB_DEVICE_CONTEXT	hDevContext,
		int	layer
	)

HRESULT inkUSBConnClrScrn	(	INKUSB_DEVICE_CONTEXT	hContext,
		INT8U	layer,
		INT8U	color
	)

HRESULT inkUSBConnDrawBitmap	(	INKUSB_DEVICE_CONTEXT	hContext,
		LCD_BITMAP *	pBitmap
	)

HRESULT inkUSBConnDrawLine	(	INKUSB_DEVICE_CONTEXT	hContext,
		LCD_LAYER	layer,
		PEN_COLOR	color,
		LCD_POINT	p1,
		LCD_POINT	p2
	)

HRESULT inkUSBConnDrawScreen	(	INKUSB_DEVICE_CONTEXT	hContext,
		LCD_SCREEN *	pScreen
	)

HRESULT inkUSBConnGetDataReport	(	INKUSB_DEVICE_CONTEXT	hContext,
		PRPTDATA	pReport,
		DWORD *	p_dwTimestamp
	)

HRESULT inkUSBConnGetLayer	(	INKUSB_DEVICE_CONTEXT	hContext,
		INT8U	layer,
		LAYER_CODE *	pLayerState
	)

HRESULT inkUSBConnGetMixCode	(	INKUSB_DEVICE_CONTEXT	hContext,
		MIX_CODE *	pMixCode
	)

HRESULT inkUSBConnGetOptions	(	INKUSB_DEVICE_CONTEXT	hContext,
		OPTIONS *	pOptions
	)

HRESULT inkUSBConnGetSystemCal	(	INKUSB_DEVICE_CONTEXT	hContext,
		SYS_CAL *	pCal
	)

HRESULT inkUSBConnMapToLCD	(	INKUSB_DEVICE_CONTEXT	hContext,
		int *	p_LCD_x,
		int *	p_LCD_y,
		int *	p_absX,
		int *	p_absY
	)

HRESULT inkUSBConnMouseEcho	(	INKUSB_DEVICE_CONTEXT	hContext,
		INT8U	bmButtons,
		INT8S	dx,
		INT8S	dy
	)

HRESULT inkUSBConnResetDefaults ( INKUSB_DEVICE_CONTEXT hContext )

HRESULT inkUSBConnSaveSettings ( INKUSB_DEVICE_CONTEXT hDevContext )

HRESULT inkUSBConnSelfTest	(	INKUSB_DEVICE_CONTEXT	hContext,
		INT8U *	pResultCode
	)

HRESULT inkUSBConnSetLayer	(	INKUSB_DEVICE_CONTEXT	hContext,
		INT8U	layer,
		LAYER_CODE	layerState
	)

HRESULT inkUSBConnSetMixCode	(	INKUSB_DEVICE_CONTEXT	hContext,
		MIX_CODE	mixCode
	)

HRESULT inkUSBConnSetOptions	(	INKUSB_DEVICE_CONTEXT	hContext,
		OPTIONS *	pOptions
	)

HRESULT inkUSBConnSetSystemCal	(	INKUSB_DEVICE_CONTEXT	hContext,
		SYS_CAL *	pCal
	)

INKUSB_CONTEXT inkUSBCreateContext	(	USR_SETTINGS_HANDLER	userSettingsHandler,
		USR_CONFIG_HANDLER	userConfigHandler,
		void *	pUserContext
	)

Creates a library instance context -- a single library instance context can have multiple devices open concurrently.

HRESULT inkUSBDbgGetDebugParam	(	INKUSB_CONTEXT	hContext,
		INKUSB_DEVICE_CONTEXT	hDeviceContext,
		PARAM_KEY	key,
		_TCHAR *	pBuffer,
		size_t	outBufferLength,
		DWORD *	p_dwLength
	)

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 inkUSBDestroyContext ( INKUSB_CONTEXT context )

Closes a given context. Closes all opened device contexts associated with the given library context.

HRESULT inkUSBDevCheckUserScreenSaverThreadTerminated	(	INKUSB_DEVICE_CONTEXT	hDevContext,
		BOOL &	retVal
	)

Used for user-defined screen-saver thread to determine if the thread has been terminated but another thread. Flag is returned as a TRUE/FALSE condition.

Note that this is NOT USED for the default screen saver thread.

HRESULT inkUSBDevConnClrScrn	(	INKUSB_DEVICE_CONTEXT	hContext,
		INT8U	layer,
		INT8U	color
	)

HRESULT inkUSBDevConnDrawBitmap	(	INKUSB_DEVICE_CONTEXT	hContext,
		LCD_BITMAP *	pBitmap
	)

HRESULT inkUSBDevConnSetLayer	(	INKUSB_DEVICE_CONTEXT	hContext,
		INT8U	layer,
		LAYER_CODE	layerState
	)

HRESULT inkUSBDevGetCachedCal	(	INKUSB_DEVICE_CONTEXT	hDevContext,
		FIRMWARE::PSYS_CAL	pSysCal
	)

HRESULT inkUSBDevGetCachedOptions	(	INKUSB_DEVICE_CONTEXT	hDevContext,
		FIRMWARE::POPTIONS	pOptions
	)

BOOLEAN inkUSBDevGetOverlappedResult	(	INKUSB_DEVICE_CONTEXT	devContext,
		LPOVERLAPPED	lpOverlapped,
		LPDWORD	lpNumberOfBytesTransferred,
		BOOL	bWait
	)

HRESULT inkUSBDevGetParam	(	INKUSB_DEVICE_CONTEXT	hDevContext,
		INKUSB_PARAM	key,
		INT32U *	pValue
	)

BOOLEAN inkUSBDevReadFile	(	INKUSB_DEVICE_CONTEXT	devContext,
		LPVOID	lpBuffer,
		DWORD	nNumberOfBytesToRead,
		LPDWORD	lpNumberOfBytesRead,
		LPOVERLAPPED	lpOverlapped
	)

HRESULT inkUSBDevReadReport	(	INKUSB_DEVICE_CONTEXT	hContext,
		FIRMWARE::REPORT_ID	id,
		void *	pBuffer,
		INT16U *	p_Length
	)

HRESULT inkUSBDevReadReport	(	INKUSB_DEVICE_CONTEXT	hContext,
		void *	pFormattedReport,
		INT16U *	p_Length
	)

HRESULT inkUSBDevRestartScreenSaverThread ( INKUSB_DEVICE_CONTEXT hDevContext )

Used to resume the screen saver thread *after* a call to inkUSBDevTerminateScreenSaverThread has occurred.

Note that the screen saver thread is created by default during the open process.

HRESULT inkUSBDevSetDebugFile	(	INKUSB_DEVICE_CONTEXT	hDevContext,
		FILE *	hFile
	)

HRESULT inkUSBDevSetParam	(	INKUSB_DEVICE_CONTEXT	hDevContext,
		INKUSB_PARAM	key,
		INT32U	value
	)

HRESULT inkUSBDevTerminateScreenSaverThread ( INKUSB_DEVICE_CONTEXT hDevContext )

Used by configuration dialog to "disable" screen saver thread while dialog is executing.

HRESULT inkUSBDevWriteReport	(	INKUSB_DEVICE_CONTEXT	hContext,
		FIRMWARE::REPORT_ID	id,
		void *	pBuffer,
		INT16U *	p_Length,
		BOOL	fIsDataThread = `FALSE`
	)

HRESULT inkUSBDevWriteReport	(	INKUSB_DEVICE_CONTEXT	hContext,
		void *	pFormattedReport,
		INT16U *	p_Length
	)

HRESULT inkUSBePadCloseConnection ( INKUSB_DEVICE_CONTEXT hContext )

HRESULT inkUSBePadConnGetMouseOn	(	INKUSB_DEVICE_CONTEXT	hContext,
		CHAR *	p_fState
	)

HRESULT inkUSBePadConnGetPhysicalExtents	(	INKUSB_DEVICE_CONTEXT	hContext,
		double *	pExtX,
		double *	pExtY
	)

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 inkUSBePadConnGetReportRate	(	INKUSB_DEVICE_CONTEXT	hContext,
		INT *	p_nPackets,
		INT *	p_milliseconds
	)

HRESULT inkUSBePadConnGetSerialNumber	(	INKUSB_DEVICE_CONTEXT	hContext,
		GUID *	p_serialNum
	)

HRESULT inkUSBePadConnPushMouseData	(	INKUSB_DEVICE_CONTEXT	hContext,
		BYTE	dx,
		BYTE	dy,
		CHAR	bmButtons
	)

HRESULT inkUSBePadConnSetMouseOn	(	INKUSB_DEVICE_CONTEXT	hContext,
		CHAR	fState
	)

IEUSB_HANDLE inkUSBePadGetDeviceHandle ( INKUSB_DEVICE_CONTEXT context )

HRESULT inkUSBePadGetNumDevices	(	INKUSB_CONTEXT	hContext,
		INT *	p_iNumDevices
	)

HRESULT inkUSBePadGetSerialNumber	(	INKUSB_CONTEXT	context,
		int	iDeviceNum,
		GUID *	p_serialNum
	)

void* inkUSBePadGetUserContext ( INKUSB_DEVICE_CONTEXT context )

Returns:: the user-defined context passed into inkUSBePadOpenConnection.

INKUSB_DEVICE_CONTEXT inkUSBePadOpenConnection	(	INKUSB_CONTEXT	context,
		INT	iDeviceNum,
		void *	pUserContext,
		PUSR_SCREENSAVER	UserScreenSaver,
		USR_DATA_READY_HOOK	userDataNotifyReady
	)

HRESULT inkUSBePadProInUse ( INKUSB_DEVICE_CONTEXT hDevContext )

USR_DATA_READY_HOOK inkUSBePadSetDataHook	(	INKUSB_DEVICE_CONTEXT	context,
		USR_DATA_READY_HOOK	userDataNotifyReady,
		void *	pUserContext
	)

HRESULT inkUSBGetParamKey	(	_TCHAR *	inStr,
		PARAM_KEY *	key
	)

HRESULT inkUSBGetScreenSaverInfo	(	INKUSB_CONTEXT	hContext,
		PSCREENSAVER_INFO	pInfo
	)

void* inkUSBGetUserContext ( INKUSB_CONTEXT context )

Returns:: the user-defined context passed into inkUSBCreateContext.

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 inkUSBintOpenConnection	(	INKUSB_DEVICE_CONTEXT	pContext,
		INT	iDeviceNum,
		BOOL	fSetupDevice = `TRUE`
	)

HRESULT inkUSBLibGetParam	(	INKUSB_CONTEXT	hLibContext,
		INKUSB_PARAM	key,
		INT32U *	pValue
	)

HRESULT inkUSBLibSetParam	(	INKUSB_CONTEXT	hLibContext,
		INKUSB_PARAM	key,
		INT32U	value
	)

HRESULT inkUSBSetDebugFile	(	INKUSB_CONTEXT	hLibContext,
		FILE *	hFile
	)

HRESULT inkUSBSetScreenSaverInfo	(	INKUSB_CONTEXT	hContext,
		PSCREENSAVER_INFO	pInfo
	)

HRESULT inkUSBShowConfig ( INKUSB_DEVICE_CONTEXT hDevContext )

HRESULT inkUSBWaitForMultEventsOrUserScreenSaverThreadTerminated	(	INKUSB_DEVICE_CONTEXT	hDevContext,
		const DWORD	eventCount,
		const HANDLE	eventArray[],
		const DWORD	timeout,
		BOOL &	abortFlag,
		DWORD &	index
	)

Used for user-defined screen-saver thread to determine if the thread has been terminated but another thread. Flag is returned as a TRUE/FALSE condition.

Note that this is NOT USED for the default screen saver thread.

Generated on Mon Dec 17 17:19:30 2007 for ePadAPIs by

1.5.4

inkUSBAPI.h File Reference

Namespaces

Classes

Defines

Typedefs

Enumerations

Functions

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation