IePadLS Interface Reference

import "ePadHancock-IDL.idl";

List of all members.

Public Member Functions
HRESULT	connGetDataRateIndex ([out, retval] BYTE *p_bRateIndex)
HRESULT	connSetDataRateIndex ([in] BYTE bRateIndex)
HRESULT	connSaveSettings ([out, retval] BYTE *p_bResultCode)
HRESULT	connResetDefaults ([in] BYTE bResetCode)
HRESULT	connGetSysCal ([out] SYSCAL *pSysCal)
HRESULT	connSetSysCal ([in] SYSCAL *pSysCal)
HRESULT	devHandleData ([in] BYTE bFlags,[in] USHORT wAbsX,[in] USHORT wAbsY,[in] USHORT bPress,[in] ULONG wTimestamp)
HRESULT	connSetEncryptionMode ([in] BYTE bEncryptionMode)
HRESULT	connGetEncryptionMode ([out] BYTE *p_bEncryptionMode)
HRESULT	connDrawLine ([in] IDL_LINE_INFO *p_LineInfo)
HRESULT	connGetInkingRegion ([out] PIDL_INK_REGION_DATA p_region)
HRESULT	connSetInkingRegion ([in] PIDL_INK_REGION_DATA p_region)
HRESULT	connCreateBitmap ([in] BYTE bBitmapId,[in] BYTE *pBuffer,[in] ULONG wBufferLength)
HRESULT	connGetUserPreferences ([out] PIDL_USER_PREFERENCES pPreferences)
HRESULT	connSetUserPreferences ([in] PIDL_USER_PREFERENCES pPreferences)
HRESULT	connClrInkRegion ()
HRESULT	devPadStackInfo ([out] INT8U fwVersion[8],[out] INT8U swVersion[8],[out] INT8U itoVersion[8])
HRESULT	connCreateEmptyBitmap ([in] INT8U bBitmapId,[in] INT16U width,[in] INT16U height,[in] IDL_LCD_RGB color)
HRESULT	connDeleteBitmap ([in] INT8U bBitmapId)
HRESULT	connSetTextWindow ([in] IDL_LCD_POINT startingPoint,[in] INT16U width,[in] INT16U height,[in] IDL_UOM unitMeasure,[in] INT8U borderSize)
HRESULT	connShowTextWindow ([in] INT8U bOnOff)
HRESULT	connSendTextForTextWindow ([in] BSTR bStrTextBuffer)
HRESULT	connSendAffirmationText ([in] BSTR bStrTextBuffer,[in] IDL_JUSTIFICATION horizJust,[in] IDL_JUSTIFICATION vertJust)
HRESULT	connGetMode ([out] IDL_OP_MODE *pMode)
HRESULT	ResetPad ([out] INT16U *pResult)
HRESULT	connShowBitmap ([in] INT8U bBitmapId,[in] INT8U bOnOff)
HRESULT	connSetBitmapAsDefault ([in] INT8U bBitmapId)
HRESULT	connSendBitmapText ([in] INT8U bBitmapID,[in] BSTR bStrTextBuffer)
HRESULT	connPositionBitmap ([in] INT8U bBitmapId,[in] INT16U xCoordinate,[in] INT16U yCoordinate)
HRESULT	connGetCharacteristics ([out, retval]INT8U Features[6])

---

Detailed Description

Interface for ePad-LS client. Available debug properties:

field name	possible values	meaning
exclusiveOpen	[0|1]	Set exclusive open property (0 = NOT exclusive open, 1 = Exclusive Open) Default is 0 (off)
legacymode	[0|1]	Set legacy open property (0 = NOT legacy open, 1 = Legacy Open, device in inking mode) Default is NOT legacy open)

All of the above fields are case-sensitive.

See also:

gIEDebugGUI::SetDebugParam

gIEDebugGUI::GetDebugParam

Definition at line 199 of file ePadHancock-IDL.idl.

---

Member Function Documentation

HRESULT IePadLS::connClrInkRegion (   )

Clears the inking region (removes any ink trails from region). Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL

HRESULT IePadLS::connCreateBitmap (  [in] BYTE  bBitmapId, [in] BYTE *  pBuffer, [in] ULONG  wBufferLength )

Creates bitmap on the specified screen (bitmapid) using given buffer. Currently only BMP and JPEG format images are supported by the device. The buffer length can not greater than 1MB. Parameters: Parameters meaning bBitmapId The desired image ID pBuffer Point to the image buffer wBufferLength The image buffer length Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate E_UNEXPECTED Failed to create temporary file on device E_OUTOFMEMORY Failed during file transfer E_ABORT Failed to execute the image file

HRESULT IePadLS::connCreateEmptyBitmap (  [in] INT8U  bBitmapId, [in] INT16U  width, [in] INT16U  height, [in] IDL_LCD_RGB  color )

Creates an empty bitmap with the specified bBitmapId. The width and height must be indicated and are in pixels. The background color is indicated using a IDL_LCD_RGB structure. Parameters: Parameters meaning bBitmapId The desired image ID. The bBitmapId field must be > 0. width Image width in pixel height Image height in pixel color Image color Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL See also: IDL_LCD_RGB

HRESULT IePadLS::connDeleteBitmap (  [in] INT8U  bBitmapId  )

Deletes the specified bBitmapId from the ePad device. The bBitmapId field must be > 0. Parameters: Parameters meaning bBitmapId To be deleted image ID Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL

HRESULT IePadLS::connDrawLine (  [in] IDL_LINE_INFO *  p_LineInfo  )

Draws a line on the specified screen id using the given color and width between starting point and end point. Parameters: Parameters meaning p_LineInfo The desired line properties Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate See also: IDL_LINE_INFO

HRESULT IePadLS::connGetCharacteristics (  [out, retval] INT8U  Features[6]  )

Get the device characteristics/features. It is six bytes and they are: 1st byte: 0 if it is a 5wire device; 1 if it is a 4wire device. 2nd-6th bytes: Reserved Parameters: Parameters meaning features 6 bytes data as described above Possible return code: Return Code meaning S_OK Done E_HANDLE The ePad device handle is NULL

HRESULT IePadLS::connGetDataRateIndex (  [out, retval] BYTE *  p_bRateIndex  )

Retrieves the device data report rate index from the ePad device. Parameters: Parameters meaning p_bRateIndex Returned report rate can be any number within the range [1-4]. To determine the data report rate per second, multiply the bRateIndex value by 100. Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate

HRESULT IePadLS::connGetEncryptionMode (  [out] BYTE *  p_bEncryptionMode  )

Gets the data encryption mode from the ePad device. Parameters: Parameters meaning p_bEncryptionMode Points the address to accept the encryption type enumerator [see notes on the SetEncryptionMode section]. Possible return code: Return Code meaning S_OK Done E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate

HRESULT IePadLS::connGetInkingRegion (  [out] PIDL_INK_REGION_DATA  p_region  )

Gets the inking region settings from the device. Parameters: Parameters meaning p_region Points to the address to accept inking region settings Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate See also: IDL_INK_REGION_DATA

HRESULT IePadLS::connGetMode (  [out] IDL_OP_MODE *  pMode  )

Query the operational mode of the ePad device. Parameters: Parameters meaning pMode The returned op mode Possible return code: Return Code meaning S_OK Done E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate See also: IDL_OP_MODE

HRESULT IePadLS::connGetSysCal (  [out] SYSCAL *  pSysCal  )

Retrieves the current calibration settings from the device. Parameters: Parameters meaning pSysCal The desired system calibration settings Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate See also: SYSCAL

HRESULT IePadLS::connGetUserPreferences (  [out] PIDL_USER_PREFERENCES  pPreferences  )

Gets the user-defined settings from the ePad device. As of the writing of this document, screen saver functions have not been implemented. Parameters: Parameters meaning pPreferences Points to the address to accept the user-defined settings. Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate See also: IDL_USER_PREFERENCES

HRESULT IePadLS::connPositionBitmap (  [in] INT8U  bBitmapId, [in] INT16U  xCoordinate, [in] INT16U  yCoordinate )

Position the designated image at the desired LCD positon. Parameters: Parameters meaning bBitmapId The designated image ID targetX The desired LCD x-coordinate targetY The desired LCD y-coordinate Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL

HRESULT IePadLS::connResetDefaults (  [in] BYTE  bResetCode  )

Resets the device's calibration and options to the powerup state. Paramters: name meaning value bResetCode individual bits to cause the following conditional action Bit Action 0 bSysCal 0: No Action required; 1: Reset sysCal parameters to Factory or Tuned settings. See bRestoreFactorySettings bit 1 bReportRate 0: No Action required; 1: Reset ReportRate to Factory or Tuned settings 2 bRestoreFactorySettings 0: Tuned settings; 1: Restore Factory settings 3 bEraseEEPROM 0: No action; 1: Erases EEPROM to all 0xff’s such that upon next device cycle an ‘empty’ EEPROM is detected 4 bDefaultImage 0: No action; 1: Redisplay default bitmap on the device 5 Reserved, set to 0 Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL

HRESULT IePadLS::connSaveSettings (  [out, retval] BYTE *  p_bResultCode  )

Saves all current values for persistent settings as the default. Parameters: Parameters meaning p_bResultCode The returned error code indicate an error occured when saving settings. 0: Means no error encountered. Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate

HRESULT IePadLS::connSendAffirmationText (  [in] BSTR  bStrTextBuffer, [in] IDL_JUSTIFICATION  horizJust, [in] IDL_JUSTIFICATION  vertJust )

Sends the text to the previous defined inking region on the ePad device. Parameters: Parameters meaning bStrTextBuffer The affirmation text horizJust Horizontal aligement vertJust Vertical aligement Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_OUTOFMEMORY The affirmation text is too long See also: IDL_JUSTIFICATION

HRESULT IePadLS::connSendBitmapText (  [in] INT8U  bBitmapID, [in] BSTR  bStrTextBuffer )

Show the RichText string over the image. Parameters: Parameters meaning bBitmapID The destination image ID bStrTextBuffer The desired RichText Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_OUTOFMEMORY The desried image it too large (over 3MB)

HRESULT IePadLS::connSendTextForTextWindow (  [in] BSTR  bStrTextBuffer  )

Sends the richtext text to the previously defined text window on the ePad device. Parameters: Parameters meaning bStrTextBuffer The desired richtext text Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_OUTOFMEMORY The text is over 64K

HRESULT IePadLS::connSetBitmapAsDefault (  [in] INT8U  bBitmapId  )

Set the bitmap to be the default background image. Parameters: Parameters meaning bBitmapId The desired image ID Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL

HRESULT IePadLS::connSetDataRateIndex (  [in] BYTE  bRateIndex  )

Sets the device data report rate index on the ePad device to a given value. Parameters: Parameters meaning bRateIndex The desired report rate range within [1-4] The pRateIndex value represents the desired data report rate per second divided by 100. The default value is 2. Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate

HRESULT IePadLS::connSetEncryptionMode (  [in] BYTE  bEncryptionMode  )

Sets the device data encryption mode on the device. Parameters: name meaning value bEncryptionMode The encryption enumerator to indicate the desired encryption type ENCRYPTION_NONE 0 Encryption off ENCRYPTION_AES256_ECB 1 256 bits AES encryption(Default) For more information, please refer to the OpenSSL library Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate E_ABORT The basic function doesn't work. E_OUTOFMEMORY Failed to create BIO file CO_E_CANT_REMOTE Couldn't create remote PEM session

HRESULT IePadLS::connSetInkingRegion (  [in] PIDL_INK_REGION_DATA  p_region  )

Sets the inking region settings on the device. Note that once the ink region is enabled, the device is put in INKING mode and will subsequently respond to a restricted subset of commands. Once the signature capture is complete, one should re-issue this method in order to disable the ink region. Parameters: Parameters meaning p_region Points to the addres to hold the desired inking region settings Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate See also: IDL_INK_REGION_DATA

HRESULT IePadLS::connSetSysCal (  [in] SYSCAL *  pSysCal  )

Writes device calibration settings to the device. Parameters: Parameters meaning pSysCal Points to the addres to accept the system calibration settings Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate See also: SYSCAL

HRESULT IePadLS::connSetTextWindow (  [in] IDL_LCD_POINT  startingPoint, [in] INT16U  width, [in] INT16U  height, [in] IDL_UOM  unitMeasure, [in] INT8U  borderSize )

Sets the text window settings on the device. This identifies what will appear on the LCD display after the connShowTextWindow() call. If the text window is too small to display the text that is provided, then a vertical scroll-bar is automatically provided on the LCD display. This scroll-bar can be manipulated with the stylus in order to allow the viewer to review the entire complement of text which has been provided. Parameters: Parameters meaning startingPoint The window's top left position width Window's width height Window's height unitMeasure The window sizing measurement borderSize The window border size Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate See also: IDL_UOM

HRESULT IePadLS::connSetUserPreferences (  [in] PIDL_USER_PREFERENCES  pPreferences  )

Sets the user-defined settings for the ePad device. As of the writing of this document, screen saver functions have not been implemented. Parameters: Parameters meaning pPreferences Points to the address holding the desired user-dfined settings Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate See also: IDL_USER_PREFERENCES

HRESULT IePadLS::connShowBitmap (  [in] INT8U  bBitmapId, [in] INT8U  bOnOff )

Show or hide the designated bitmap on the ePad LCD screen. Parameters: Parameters meaning bBitmapId The designated image ID bOnOff The flag to indicate whether to show/hide the target image 1 shows the target image 0 hides the target image Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL

HRESULT IePadLS::connShowTextWindow (  [in] INT8U  bOnOff  )

Show or hide the text window. This command applies to the window previously set by the connSetTextWindow method. Parameters: Parameters meaning bOnOff The flag to show/hide the desired text window. 1 shows the text window 0 hides the text window Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL

HRESULT IePadLS::devHandleData (  [in] BYTE  bFlags, [in] USHORT  wAbsX, [in] USHORT  wAbsY, [in] USHORT  bPress, [in] ULONG  wTimestamp )

Reserved for internal use only.

HRESULT IePadLS::devPadStackInfo (  [out] INT8U  fwVersion[8], [out] INT8U  swVersion[8], [out] INT8U  itoVersion[8] )

Reserved for internal use only.

HRESULT IePadLS::ResetPad (  [out] INT16U *  pResult  )

Reset the device to READY status. Once reset, the ePad should be ready to accept HID reports and the encryption mode should be off.. Parameters: Parameters meaning pResult Accept the result code from FW. O means FW has been successfully reset non 0 means error occurs when FW resetting Possible return code: Return Code meaning S_OK Done E_ACCESSDENIED The device is not ready to accept the report E_FAIL Failed to call underneath I/O API E_HANDLE The ePad device handle is NULL E_INVALIDARG The parameters are invalidate See also: IDL_OP_MODE

---