IePadPro Interface Reference

List of all members.

Public Member Functions

HRESULT connGetDataRateIndex ([out, retval] BYTE *p_bResultCode)
HRESULT connSetDataRateIndex ([in] BYTE bRateIndex)
HRESULT connSaveSettings ([out, retval] BYTE *p_bResultCode)
HRESULT connResetDefaults ([in] BYTE bResetCode)
HRESULT connGetSysCal ([out] struct tag_ePadPro_SYSCAL *pSysCal)
HRESULT connSetSysCal ([in] struct tag_ePadPro_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 connGetContrast ([in] BYTE *p_bContrastValue)
HRESULT connSetContrast ([in] BYTE bContrastValue)
HRESULT connGetBacklight ([out] BYTE *p_onOffAuto,[out] BYTE *p_bIntensity,[out] USHORT *p_wAutotime_10mSec)
HRESULT connSetBacklight ([in] BYTE bOnOffAuto,[in] BYTE bIntensity,[in] USHORT wAutotime_10mSec)
HRESULT connGetInkingRegion ([out] PEPADPRO_IDL_INK_REGION_DATA p_region)
HRESULT connSetInkingRegion ([in] PEPADPRO_IDL_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 connCopyImage (INT8U bBitmapScreenId, INT16U sourceX, INT16U sourceY, INT16U srcWidthInPixels, INT16U srcHeightInPixels, INT8U bDestScreenId, INT16U destX, INT16U destY, INT16U destWidthInPixels, INT16U destHeightInPixels, INT8U bStretch, IDL_BITMAP_OP op)
HRESULT connClrInkRegion ()
HRESULT connClrScreen (INT8U bBitmapScreenId, INT16U sourceX, INT16U sourceY, INT16U width, INT16U height, INT8U red, INT8U green, INT8U blue)
HRESULT connWriteText (INT8U bScreenId, INT16U reservedSetToZero, IDL_LCD_RGB bgColor, IDL_LCD_RGB fgColor, IDL_LCD_POINT startingPoint, BSTR TextBuffer, INT32U wTextFlags)
HRESULT devPadStackInfo (INT8U fwVersion[8], INT8U swVersion[8], INT8U itoVersion[8])
HRESULT connCreateEmptyBitmap (INT8U bBitmapId, INT16U width, INT16U height, IDL_LCD_RGB color)
HRESULT connDeleteBitmap (INT8U bBitmapId)
HRESULT connSetFactorySysCal ([in] struct tag_ePadPro_SYSCAL *pSysCal,[in] BSTR secretWords)


Detailed Description

Interface for ePadPro (ePadInkPro/ePadIdPro) client. Available debug properties:

field namepossible valuesmeaning
exclusiveOpenSet exclusive open property [0|1]Default is 0 (off)

All of the above fields are case-sensitive.

See also:
gIEDebugGUI::SetDebugParam

gIEDebugGUI::GetDebugParam


Member Function Documentation

HRESULT connGetDataRateIndex ( [out, retval] BYTE *  p_bResultCode  ) 

Gets the device data report rate index from the device.

The index can be any number within the range [1-4]. To determine the data report rate per second, multiple the index value by 100.

HRESULT connSetDataRateIndex ( [in] BYTE  bRateIndex  ) 

Sets the device data report rate index on the device.

The Index can be any number within the range [1-4]. The index value represents the desired data report rate per second divided by 100. The default value is 2.

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

Saves the device's settings as the default.

HRESULT connResetDefaults ( [in] BYTE  bResetCode  ) 

Resets the device's calibration and options to the powerup state.

ResetCode is defined as follows:

valuemeaning
1sysCal
2Report Rate
4Restore Factory Setting
8Erase EEPROM
16Redisplay Default Bitmap
32Restore InkRegion
64Restore All tuned data

HRESULT connGetSysCal ( [out] struct tag_ePadPro_SYSCAL pSysCal  ) 

Retrieves the current calibration settings from the device.

HRESULT connSetSysCal ( [in] struct tag_ePadPro_SYSCAL pSysCal  ) 

Writes device calibration settings to the device.

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

Reserved for internal use only.

HRESULT connSetEncryptionMode ( [in] BYTE  bEncryptionMode  ) 

Sets the device data encryption mode on the device.

The index can be any number within the range [0-5]. The meaning of each value is as follows:
namevaluemeaning
ENCRYPTION_NONE0Encryption off
ENCRYPTION_AES128_ECB1128 bits AES encryption
ENCRYPTION_AES192_ECB2192 bits AES encryption
ENCRYPTION_AES256_ECB3256 bits AES encryption(Default)
ENCRYPTION_DES644DES 64 bits Encryption
ENCRYPTION_3DES1925DES 192 bits Encryption

Please refer to www.openssl.org for more information about openssl library.

HRESULT connGetEncryptionMode ( [out] BYTE *  p_bEncryptionMode  ) 

Gets the data encryption mode from the device.

[see notes on the SetEncryptionMode section].

HRESULT 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.

See also:
IDL_LINE_INFO

HRESULT connGetContrast ( [in] BYTE *  p_bContrastValue  ) 

Gets the LCD contrast level from the device. If this value is set to 0, the LCD is off.

HRESULT connSetContrast ( [in] BYTE  bContrastValue  ) 

Sets the LCD contrast level. To turn LCD off, set this value to 0, maximum value.

HRESULT connGetBacklight ( [out] BYTE *  p_onOffAuto,
[out] BYTE *  p_bIntensity,
[out] USHORT *  p_wAutotime_10mSec 
)

Gets the backlight setting from the device.

When Autotime_10mSec is not equal to 0, it is in auto mode.

HRESULT connSetBacklight ( [in] BYTE  bOnOffAuto,
[in] BYTE  bIntensity,
[in] USHORT  wAutotime_10mSec 
)

Sets the backlight setting on the device.

When Autotime_10mSec is not equal to 0, it is in auto mode.

HRESULT connGetInkingRegion ( [out] PEPADPRO_IDL_INK_REGION_DATA  p_region  ) 

Gets the inking region setting from the device.

See also:
IDL_INK_REGION_DATA

HRESULT connSetInkingRegion ( [in] PEPADPRO_IDL_INK_REGION_DATA  p_region  ) 

Sets the inking region on the device.

See also:
IDL_INK_REGION_DATA

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

Creates bitmap on the specified screen (bitmapid) using given buffer.

Currently BMP, JPEG and GIF format images are supported by the ePadPro device.

The buffer length can not be greater than 1MB.

It is recommend to use Windows' GDI routines, such as GetDC(), CreateCompatibleDC(), CreateCompatibleBitmap(), GetDIBits() etc to create bitmap in memory. CImage class can help to save memory bitmap into different image file types.

HRESULT connGetUserPreferences ( [out] PIDL_USER_PREFERENCES  pPreferences  ) 

Gets user-defined settings from the device

As of the writing of this document, screen saver functions have not been implemented.

See also:
IDL_USER_PREFERENCES

HRESULT connSetUserPreferences ( [in] PIDL_USER_PREFERENCES  pPreferences  ) 

Sets user-defined settings for this device.

As of the writing of this document, screen saver functions have not been implemented.

See also:
IDL_USER_PREFERENCES

HRESULT connCopyImage ( INT8U  bBitmapScreenId,
INT16U  sourceX,
INT16U  sourceY,
INT16U  srcWidthInPixels,
INT16U  srcHeightInPixels,
INT8U  bDestScreenId,
INT16U  destX,
INT16U  destY,
INT16U  destWidthInPixels,
INT16U  destHeightInPixels,
INT8U  bStretch,
IDL_BITMAP_OP  op 
)

Copies the bitmap from the specified source screen (bitmapid) to destination screen using specified operation.

IDL_BITMAP_OP operations are
namevaluemeaning
DISP_COPY_IMAGE0COPY
DISP_OR_IMAGE1OR
DISP_XOR_IMAGE2XOR
DISP_AND_IMAGE3AND

As of the writing of this document, only the copy operation is supported. Other operations and the stretch flag have not been implemented.

HRESULT connClrInkRegion (  ) 

Clears the inking region (removes any ink trails from region)

HRESULT connClrScreen ( INT8U  bBitmapScreenId,
INT16U  sourceX,
INT16U  sourceY,
INT16U  width,
INT16U  height,
INT8U  red,
INT8U  green,
INT8U  blue 
)

Clears display to user-defined entity

HRESULT connWriteText ( INT8U  bScreenId,
INT16U  reservedSetToZero,
IDL_LCD_RGB  bgColor,
IDL_LCD_RGB  fgColor,
IDL_LCD_POINT  startingPoint,
BSTR  TextBuffer,
INT32U  wTextFlags 
)

Writes text in the TextBuffer to the device using the given background/foreground color and the starting location.

As of the writing of this document, the TextFlags field has not been implemented. Only the default system font is supported.

See also:
IDL_LCD_RGB

IDL_LCD_POINT

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

Reserved for internal use only.

HRESULT connCreateEmptyBitmap ( INT8U  bBitmapId,
INT16U  width,
INT16U  height,
IDL_LCD_RGB  color 
)

Creates an empty bitmap with the specified screen id with the given width and height in pixels and background color.

The screen id can not be 0.

See also:
IDL_LCD_RGB

HRESULT connDeleteBitmap ( INT8U  bBitmapId  ) 

Deletes the specified screen id from the device. The screen id can not be 0.

HRESULT connSetFactorySysCal ( [in] struct tag_ePadPro_SYSCAL pSysCal,
[in] BSTR  secretWords 
)

Reserved for internal use only.


Generated on Mon Dec 17 17:19:32 2007 for ePadAPIs by  doxygen 1.5.4