ePadLSActiveXLib::_DePadLSActiveX Interface Reference

import "ePadLSActiveX.idl";

List of all members.

Public Member Functions

void AboutBox ()
SHORT GetNumDevices (void)
SHORT OpenConnection (SHORT nNumDevice, SHORT nLegacyMode)
SHORT CloseConnection (void)
SHORT connGetDataRateIndex (BYTE *index)
SHORT connSetDataRateIndex (BYTE index)
SHORT connSaveSettings (void)
SHORT connResetDefaults (BYTE code)
SHORT connSetEncryptionMode (BYTE mode)
SHORT connGetEncryptionMode (BYTE *mode)
SHORT connDrawLine (BYTE ScreenId, BYTE red, BYTE green, BYTE blue, BYTE alpha, BYTE width, SHORT xStart, SHORT yStart, SHORT xEnd, SHORT yEnd)
SHORT connGetInkRegion (BYTE *bEnabled, BYTE *bOn, BYTE *bEnableType, BYTE *bTransform, SHORT *xStart, SHORT *yStart, SHORT *nWidth, SHORT *nHeight, BYTE *red, BYTE *green, BYTE *blue, BYTE *nPenWidth, SHORT *wTimeout, SHORT *wEnableTimeout)
SHORT connSetInkRegion (BYTE bEnabled, BYTE bOn, BYTE bEnableType, BYTE bTransform, SHORT xStart, SHORT yStart, SHORT nWidth, SHORT nHeight, BYTE red, BYTE green, BYTE blue, BYTE alpha, BYTE nPenWidth, SHORT wTimeout)
SHORT connCreateBitmap (BYTE bBitmapId, BSTR filePath)
SHORT connShowBitmap (BYTE bBitmapId, BYTE bFlag)
BSTR connGetSerialNumber (void)
LONG connGetDataRangeMinX (void)
LONG connGetDataRangeMinY (void)
LONG connGetDataRangeMinZ (void)
LONG connGetDataRangeMaxX (void)
LONG connGetDataRangeMaxY (void)
LONG connGetDataRangeMaxZ (void)
DOUBLE connGetPhysicalX (void)
DOUBLE connGetPhysicalY (void)
SHORT connClrInkRegion ()
SHORT connCreateEmptyBitmap (BYTE bBitmapId, SHORT width, SHORT height, BYTE red, BYTE green, BYTE blue, BYTE alpha)
SHORT connDeleteBitmap (BYTE bBitmapId)
BSTR connGetDebugParam (BSTR pKey)
SHORT connSetDebugParam (BSTR pKey, BSTR pValue)
SHORT connSetTextWindow (SHORT xStart, SHORT yStart, SHORT nWidth, SHORT nHeight, BYTE BorderUnit, BYTE BorderSize)
SHORT connShowTextWindow (BYTE bOnOff)
SHORT connSendTextForTextWindow (BSTR bStrTextBuffer)
SHORT connSendAffirmationText (BSTR textStrBuffer, BYTE horizon, BYTE vertical)
SHORT connGetMode (BYTE *Mode)
SHORT connResetPad (SHORT *retValue)
SHORT connSetBitmapAsDefault (BYTE bBitmapId)
SHORT connSendBitmapText (BYTE bBitmapId, BSTR bStrBuffer)
SHORT connPositionBitmap (BYTE bBitmapId, SHORT xPos, SHORT yPos)
SHORT connGetUserPref ([out] BYTE *pEncryptionMode)
SHORT connSetUserPref ([in] BYTE EncryptionMode)
SHORT connGetCharacteristics ([out] BYTE *pFeature1, BYTE *pFeature2, BYTE *pFeature3, BYTE *pFeature4, BYTE *pFeature5, BYTE *pFeature6)
SHORT connIsPressureEnabled ()


Detailed Description

Definition at line 22 of file ePadLSActiveX.idl.


Member Function Documentation

void ePadLSActiveXLib::_DePadLSActiveX::AboutBox  ) 
 

Pop up About model dialog box to display ActiveX version number, name, copyright and etc.

SHORT ePadLSActiveXLib::_DePadLSActiveX::CloseConnection void   ) 
 

Close the active connection to a device, if it exists.

Possible return value:
Return ValueMeaning
Not 0The connection has been closed seccessfully.
0Failed to close the connection for any reason.

See also:
gIIEPad::CloseConnection

SHORT ePadLSActiveXLib::_DePadLSActiveX::connClrInkRegion  ) 
 

Clear the inking region (removes any ink trails from region).

Possible return value:
Return ValueMeaning
Not 0The inking region has been successfully cleared.
0Failed to clear inking region.

See also:
IePadLS::connClrInkRegion

SHORT ePadLSActiveXLib::_DePadLSActiveX::connCreateBitmap BYTE  bBitmapId,
BSTR  filePath
 

Create bitmap on the specified screen (bitmapid) with image data from file

Currently only BMP and JPEG format images are supported by the device. The length of image data can not greater than 1MB.

Paramters: See the parameters in IePadLS::connCreateBitmap

Possible return value:
Return ValueMeaning
Not 0The image has been seccessfully received.
0Failed to create image.

See also:
IePadLS::connCreateBitmap

SHORT ePadLSActiveXLib::_DePadLSActiveX::connCreateEmptyBitmap BYTE  bBitmapId,
SHORT  width,
SHORT  height,
BYTE  red,
BYTE  green,
BYTE  blue,
BYTE  alpha
 

Create an empty bitmap with the specified bBitmapId. The width and height must be indicated and are in pixels.

Parameters: See the parameters in IePadLS::connCreateEmptyBitmap

Possible return value:
Return ValueMeaning
Not 0The empty bitmap has been successfully created.
0Failed to create empty image.

See also:
IePadLS::connCreateEmptyBitmap

SHORT ePadLSActiveXLib::_DePadLSActiveX::connDeleteBitmap BYTE  bBitmapId  ) 
 

Delete the specified bitmap from the ePad device. The bBitmapId field must be > 0.

Parameters: See the parameters in IePadLS::connDeleteBitmap

Possible return value:
Return ValueMeaning
Not 0The bitmap has been successfully deleted.
0Failed to delete the bitmap.

See also:
IePadLS::connDeleteBitmap

SHORT ePadLSActiveXLib::_DePadLSActiveX::connDrawLine BYTE  ScreenId,
BYTE  red,
BYTE  green,
BYTE  blue,
BYTE  alpha,
BYTE  width,
SHORT  xStart,
SHORT  yStart,
SHORT  xEnd,
SHORT  yEnd
 

Draw a line on the specified screen id using the given color and width between starting point and end point.

Paramters: See the parameters in IePadLS::connDrawLine

Possible return value:
Return ValueMeaning
Not 0The line has been seccessfully drawn.
0Failed to draw the line.

See also:
IePadLS::connDrawLine

SHORT ePadLSActiveXLib::_DePadLSActiveX::connGetCharacteristics [out] BYTE *  pFeature1,
BYTE *  pFeature2,
BYTE *  pFeature3,
BYTE *  pFeature4,
BYTE *  pFeature5,
BYTE *  pFeature6
 

Retrieve the characteristics of the device.

Parameters: The pFeature1--pFeature6 are corresponing to the array elements of IePadLS::connGetCharacteristics parameter.

Possible return value:
Return ValueMeaning
Not 0The characteristics have been successfully retrived.
0Failed to retrieve the characteristics.

See also:
IePadLS::connGetCharacteristics

LONG ePadLSActiveXLib::_DePadLSActiveX::connGetDataRangeMaxX void   ) 
 

Return max value of pen data X field range.

See also:
gIIEPad::ConnGetRanges

LONG ePadLSActiveXLib::_DePadLSActiveX::connGetDataRangeMaxY void   ) 
 

Return max value of pen data Y field range.

See also:
gIIEPad::ConnGetRanges

LONG ePadLSActiveXLib::_DePadLSActiveX::connGetDataRangeMaxZ void   ) 
 

Return max value of pen data Z(pressure) field range.

See also:
gIIEPad::ConnGetRanges

LONG ePadLSActiveXLib::_DePadLSActiveX::connGetDataRangeMinX void   ) 
 

Return min value of pen data X field range.

See also:
gIIEPad::ConnGetRanges

LONG ePadLSActiveXLib::_DePadLSActiveX::connGetDataRangeMinY void   ) 
 

Return min value of pen data Y field range.

See also:
gIIEPad::ConnGetRanges

LONG ePadLSActiveXLib::_DePadLSActiveX::connGetDataRangeMinZ void   ) 
 

Returns min value of pen data Z (pressure) field range.

See also:
gIIEPad::ConnGetRanges

SHORT ePadLSActiveXLib::_DePadLSActiveX::connGetDataRateIndex BYTE *  index  ) 
 

Retrieve the device data report rate index from the ePad device.

Parameters:
ParametersMeaning
indexThe place to hold the returned rate index

Possible return value:
Return ValueMeaning
Not 0The rate index has been seccessfully retrieved.
0Failed to retrieve the rate index.

See also:
IePadLS::connGetDataRateIndex

BSTR ePadLSActiveXLib::_DePadLSActiveX::connGetDebugParam BSTR  pKey  ) 
 

Get provider-specific parameters for provider instance. See the description of the provider for specific value-pairs.

See also:
gIEDebugGUI::GetDebugParam

SHORT ePadLSActiveXLib::_DePadLSActiveX::connGetEncryptionMode BYTE *  mode  ) 
 

Get the data encryption mode from the device

Paramters: See the parameters in IePadLS::connGetEncryptionMode

Possible return value:
Return ValueMeaning
Not 0The encryption mode has been seccessfully retrieved.
0Failed to retrieve the encryption mode.

See also:
IePadLS::connGetEncryptionMode

SHORT ePadLSActiveXLib::_DePadLSActiveX::connGetInkRegion BYTE *  bEnabled,
BYTE *  bOn,
BYTE *  bEnableType,
BYTE *  bTransform,
SHORT *  xStart,
SHORT *  yStart,
SHORT *  nWidth,
SHORT *  nHeight,
BYTE *  red,
BYTE *  green,
BYTE *  blue,
BYTE *  nPenWidth,
SHORT *  wTimeout,
SHORT *  wEnableTimeout
 

Get the inking region settings from the device.

Paramters: See the parameters in IePadLS::connGetInkingRegion

Possible return value:
Return ValueMeaning
Not 0The inking region settings have been seccessfully received.
0Failed to retrieve inking region settings.

See also:
IePadLS::connGetInkingRegion

SHORT ePadLSActiveXLib::_DePadLSActiveX::connGetMode BYTE *  Mode  ) 
 

Query the operational mode of the ePad device.

Parameters: See the parameters in IePadLS::connGetMode

Possible return value:
Return ValueMeaning
Not 0The operational mode has been successfully retrieved.
0Failed to retrive the operational mode.

See also:
IePadLS::IDL_OP_MODE

IePadLS::connGetMode

DOUBLE ePadLSActiveXLib::_DePadLSActiveX::connGetPhysicalX void   ) 
 

Return the device writeable horizontal physical size in inches.

See also:
gIIEPad::ConnGetPhysicalExtents

DOUBLE ePadLSActiveXLib::_DePadLSActiveX::connGetPhysicalY void   ) 
 

Return the device writeable vertival physical size in inches.

See also:
gIIEPad::ConnGetPhysicalExtents

BSTR ePadLSActiveXLib::_DePadLSActiveX::connGetSerialNumber void   ) 
 

Return the serial # of the current opened device.

Possible return value: The device serial number in GUID format.

See also:
gIIEPad::ConnGetSerialNumber

SHORT ePadLSActiveXLib::_DePadLSActiveX::connGetUserPref [out] BYTE *  pEncryptionMode  ) 
 

Get the user-defined settings from the ePad device.

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

Parameters: See IDL_USER_PREFERENCES::bEncryptionType

Possible return value:
Return ValueMeaning
Not 0The user-defined settings have been successfully retrived.
0Failed to retrieve the user-defined settings

See also:
IePadLS::connGetUserPref

See IDL_USER_PREFERENCES::bEncryptionType

SHORT ePadLSActiveXLib::_DePadLSActiveX::connIsPressureEnabled  ) 
 

Check whether the pressure value is usefull or not.

Return:
Valuemeaning
0The pressure value is meaningless
none 0The pad reports usefull pressure vale

SHORT ePadLSActiveXLib::_DePadLSActiveX::connPositionBitmap BYTE  bBitmapId,
SHORT  xPos,
SHORT  yPos
 

Position the designated image at the desired LCD positon.

Parameters: See parameters in IePadLS::connPositionBitmap

Possible return value:
Return ValueMeaning
Not 0The image has been successfully positioned.
0Failed to position the image.

See also:
IePadLS::connPositionBitmap

SHORT ePadLSActiveXLib::_DePadLSActiveX::connResetDefaults BYTE  code  ) 
 

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

Paramters: See the parameters in IePadLS::connResetDefaults

Possible return value:
Return ValueMeaning
Not 0The device has been seccessfully reset.
0Failed to reset device.

See also:
IePadLS::connResetDefaults

SHORT ePadLSActiveXLib::_DePadLSActiveX::connResetPad SHORT *  retValue  ) 
 

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: See parameters in IePadLS::ResetPad

Possible return value:
Return ValueMeaning
Not 0The pad has been successfully reset.
0Failed to reset the device.

See also:
IePadLS::ResetPad

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSaveSettings void   ) 
 

Save all current values for persistent settings as the default.

Possible return value:
Return ValueMeaning
Not 0The settings have been seccessfully saved.
0Failed to save the settings.

See also:
IePadLS::connSaveSettings

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSendAffirmationText BSTR  textStrBuffer,
BYTE  horizon,
BYTE  vertical
 

Send the text to the previous defined inking region on the ePad device.

Parameters: See the parameters in IePadLS::connSendAffirmationText

Possible return value:
Return ValueMeaning
Not 0The text has been successfully sent to the inking region.
0Failed to send the text to the inking region.

See also:
IePadLS::connSendAffirmationText

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSendBitmapText BYTE  bBitmapId,
BSTR  bStrBuffer
 

Show the RichText string over the image.

Parameters: See parameters in IePadLS::connSendBitmapText

Possible return value:
Return ValueMeaning
Not 0The text has been successfully shown.
0Failed to show the text.

See also:
IePadLS::connSendBitmapText

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSendTextForTextWindow BSTR  bStrTextBuffer  ) 
 

Send the richtext text to the previously defined text window on the ePad device.

Parameters: See the parameters in IePadLS::connSendTextForTextWindow

Possible return value:
Return ValueMeaning
Not 0The text has been successfully sent to the desired text window.
0Failed to send the text to the text window.

See also:
IePadLS::connSendTextForTextWindow

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSetBitmapAsDefault BYTE  bBitmapId  ) 
 

Set the bitmap to be the default background image.

Parameters: See parameters in IePadLS::connSetBitmapAsDefault

Possible return value:
Return ValueMeaning
Not 0The default background image has been successfully set.
0Failed to set the default background image.

See also:
IePadLS::connSetBitmapAsDefault

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSetDataRateIndex BYTE  index  ) 
 

Set the device data report rate index on the ePad device to a given value.

Parameters:
ParametersMeaning
indexThe desired rate index

Possible return value:
Return ValueMeaning
Not 0The rate index has been seccessfully set.
0Failed to set the rate index.

See also:
IePadLS::connSetDataRateIndex

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSetDebugParam BSTR  pKey,
BSTR  pValue
 

Set provider-specific parameters for provider instance. See the description of the provider for specific value-pairs.

This method can be called before openConnection() is issued. One of the functions frequently used is to suppress the configuration dialog. To do so, set pKey = "openConfig" and pValue = "0".

See also:
gIEDebugGUI::SetDebugParam

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSetEncryptionMode BYTE  mode  ) 
 

Set the data encryption mode on the device

Paramters: See the parameters in IePadLS::connSetEncryption

Possible return value:
Return ValueMeaning
Not 0The encryption mode has been seccessfully set.
0Failed to set the encryption mode.

See also:
IePadLS::connSetEncryption

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSetInkRegion BYTE  bEnabled,
BYTE  bOn,
BYTE  bEnableType,
BYTE  bTransform,
SHORT  xStart,
SHORT  yStart,
SHORT  nWidth,
SHORT  nHeight,
BYTE  red,
BYTE  green,
BYTE  blue,
BYTE  alpha,
BYTE  nPenWidth,
SHORT  wTimeout
 

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

Paramters: See the parameters in IePadLS::connSetInkingRegion

Possible return value:
Return ValueMeaning
Not 0The inking region settings have been seccessfully received.
0Failed to retrieve inking region settings.

See also:
IePadLS::connSetInkingRegion

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSetTextWindow SHORT  xStart,
SHORT  yStart,
SHORT  nWidth,
SHORT  nHeight,
BYTE  BorderUnit,
BYTE  BorderSize
 

Set 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: See the parameters in IePadLS::connSetTextWindow

Possible return value:
Return ValueMeaning
Not 0The text window has been successfully set.
0Failed to set the text window.

See also:
IePadLS::connSetTextWindow

SHORT ePadLSActiveXLib::_DePadLSActiveX::connSetUserPref [in] BYTE  EncryptionMode  ) 
 

Set the user-defined settings for the ePad device.

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

The encryption setting will take effective in next device connection session. During the current connection session, user can call connGetEncryptionMode/connSetEncryptionMode to query or set the encryption mode.

Parameters: See IDL_USER_PREFERENCES::bEncryptionType

Possible return value:
Return ValueMeaning
Not 0The user-defined settings have been successfully set.
0Failed to set the user-defined settings

See also:
IePadLS::connSetUserPref

See IDL_USER_PREFERENCES::bEncryptionType

SHORT ePadLSActiveXLib::_DePadLSActiveX::connShowBitmap BYTE  bBitmapId,
BYTE  bFlag
 

Set the previous created bitmap id to be displayed (bFlag = 1) or hide on the LCD.

Paramters: See the parameters in IePadLS::connShowBitmap

Possible return value:
Return ValueMeaning
Not 0The image showing/hiding is done.
0Failed to show/hide the image.

See also:
IePadLS::connShowBitmap

SHORT ePadLSActiveXLib::_DePadLSActiveX::connShowTextWindow BYTE  bOnOff  ) 
 

Show or hide the text window. This command applies to the window previously set by the connSetTextWindow method.

Parameters: See the parameters in IePadLS::connShowTextWindow

Possible return value:
Return ValueMeaning
Not 0The text window has been successfully shown/hiden.
0Failed to show/hide the text window.

See also:
IePadLS::connShowTextWindow

SHORT ePadLSActiveXLib::_DePadLSActiveX::GetNumDevices void   ) 
 

Return the # of attached ePadLS devices. Note that the index # is zero-based, thus if a single unit is reported it's index will be 0:

              SHORT sNumDevices = pLS->GetNumDevices();
              if ( sNumDevices>0 ) {
                 ...
                 SHORT sResult = pLS->OpenConnection(0);
                 ...
              } // endif
            

See also:
gIIEPad::GetNumDevices

SHORT ePadLSActiveXLib::_DePadLSActiveX::OpenConnection SHORT  nNumDevice,
SHORT  nLegacyMode
 

Open a connection to the device indexed by nNumDevice, if it exists. OpenConnectin can be opened with legacy mode when nLegacyMode set to 1, the IDL_OP_MODE to be INKING. If nLegacyMode set to 0, IDL_OP_MODE will set to READY mode. This case requires user application to use SetInkRegion to update the IDL_OP_MODE.

Parameters:
ParametersMeaning
nNumDeviceThe desired device index # (0-based)
nLegacyModeThe flag to indicate whether to open the device in legacy mode

Possible return value:
Return ValueMeaning
Not 0If the connection has been successfully created.
0Failed to create connection for any reason.

See also:
gIIEPad::OpenConnection

IePadLS::IDL_OP_MODE


Generated on Tue Nov 21 11:11:30 2006 for ePadAPIs by  doxygen 1.4.6-NO