visit Kofax web site
ACTIVESWLib::ISPTablet

ACTIVESWLib::ISPTablet Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPTabletInterface ISPTablet.

Includes all definitions for low level tablet access, please see ISPGuiAcqu, ISPGuiDisp and ISPGuiDyn for tablet access with a graphical representation.

Note:
Registered event listeners persistence is bound to the lifetime of the ISPTablet object, independent of the native object.


Public Member Functions

HRESULT Acquire ([in] __int64 hwndParent,[out, retval] long *result)
 Start acquiry mode.
HRESULT Acquire32 ([in] __int32 hwndParent,[out, retval] long *result)
 Start acquiry mode.
HRESULT AcquireDone ([out, retval] long *result)
 Terminate acquiry mode.
HRESULT ClearBackgroundImage ([in] long iImFlags,[out, retval] long *result)
 Clear the backgound image.
HRESULT Connect ([out, retval] long *result)
 Connect with a tablet.
HRESULT CreateTablet ([in] long iDriverId,[out, retval] long *result)
 Create a new tablet structure.
HRESULT CreateTabletByAlias ([in] BSTR bstrTabletAlias,[out, retval] long *result)
 Create a new tablet structure based on an Alias.
HRESULT CreateTabletByEnum ([in] ISPPropertyMap *spDescriptor,[out, retval] long *result)
 create a tablet by an enumeration
HRESULT CreateTabletEx ([in] BSTR bstrTabletClass,[in] BSTR bstrConfig,[out, retval] long *result)
 Create a new tablet structure.
HRESULT Disconnect ([out, retval] long *result)
 Disconnect a tablet.
HRESULT GetDevice ([out] long *piDevice,[out, retval] long *result)
 Query the device from a tablet.
HRESULT GetDeviceStr ([in] long iDevice,[out] BSTR *bstrDevice,[out, retval] long *result)
 Query the device name.
HRESULT GetDisplayType ([out] long *piDisplayType,[out, retval] long *result)
 Query the display type of the tablet used by this SPTablet object.
HRESULT GetDriver ([out] long *piDriver,[out, retval] long *result)
 Query the driver from a tablet.
HRESULT GetDriverStr ([in] long iDriver,[out] BSTR *bstrDriver,[out, retval] long *result)
 Query the driver name.
HRESULT GetFlags ([out] long *piFlags,[out, retval] long *result)
 Query the tablet flags during acquiry mode.
HRESULT GetHardwareName ([out] BSTR *bstrHardwareName,[out, retval] long *result)
 Get the hardware file name of an SPTablet object.
HRESULT GetLCD ([out] long *piLCD,[out, retval] long *result)
 Get the tablet LCD mode during acquiry mode.
HRESULT GetLCDBitsPerPixel ([out] long *piBits,[out, retval] long *result)
 Query bits per pixel of the attached LCD screen in pixel.
HRESULT GetLCDSize ([out] long *piWidth,[out] long *piHeight,[out, retval] long *result)
 Query size of the attached LCD screen in pixel.
HRESULT GetMaxPressure ([out] long *piMaxPressure,[out, retval] long *result)
 Query the pressure range from a tablet.
HRESULT GetPadSerial ([out] SAFEARRAY(BYTE)*psaPadSerial,[out, retval] long *result)
 Query the tablet serial identification.
HRESULT GetPhysicalSize ([out] long *piWidth,[out] long *piHeight,[out, retval] long *result)
 Query the tablet size from a tablet [in mm].
HRESULT GetResolution ([out] long *piResolution,[out, retval] long *result)
 Query the logical resolution from a tablet.
HRESULT GetResolution2 ([in] long lDetail,[out] long *piResolution,[out, retval] long *result)
 Query the resolution from a tablet.
HRESULT GetSampleRate ([out] long *piSampleRate,[out, retval] long *result)
 Query the logical Sample Rate from a tablet.
HRESULT GetSampleRate2 ([in] long lDetail,[out] long *piSampleRate,[out, retval] long *result)
 Query the Sample Rate from a tablet.
HRESULT GetState ([out] long *piState,[out, retval] long *result)
 Query the tablet state.
HRESULT GetTabletSize ([out] long *piWidth,[out] long *piHeight,[out, retval] long *result)
 Query the tablet size from a tablet [in tablet coordinates].
HRESULT GetTabletType ([out] long *piType,[out, retval] long *result)
 Query the tablet type.
HRESULT GetTimeStamp ([out] long *piTimeStamp,[out, retval] long *result)
 Query the timestamp of the last acquired signature.
HRESULT HasExternalLCD ([out] long *pbExternalLCD,[out, retval] long *result)
 Query if the tablet is a model with external LCD.
HRESULT HasProximity ([out] long *piProximity,[out, retval] long *result)
 Query proximity of the tablet.
HRESULT ReloadParameters ([out, retval] long *result)
 Reload the tablet parameters.
HRESULT Reset ([in] long bReset,[out, retval] long *result)
 Reset the tablet driver.
HRESULT SetBackgroundImage ([in] SAFEARRAY(BYTE)*pszImage,[out, retval] long *result)
 Pass a backgound image.
HRESULT SetBackgroundImage2 ([in] long iImFlags,[in] SAFEARRAY(BYTE)*pszImage,[out, retval] long *result)
 Pass a backgound image.
HRESULT SetClipRectangle ([in] long iLeft,[in] long iTop,[in] long iRight,[in] long iBottom,[out, retval] long *result)
 Set the clipping rectangle for the tablet display.
HRESULT SetDevice ([in] long iDevice,[out, retval] long *result)
 Set the device id for a tablet.
HRESULT SetDisplayType ([in] long iDisplayType,[out, retval] long *result)
 Set the display type of the tablet used by this SPTablet object.
HRESULT SetDriver ([in] long iDriver,[out, retval] long *result)
 Set the driver for a tablet.
HRESULT SetFlags ([in] long iFlags,[out, retval] long *result)
 Set the tablet flags during acquiry mode.
HRESULT SetLCD ([in] long iLCD,[out, retval] long *result)
 Set the tablet LCD mode during acquiry mode.
HRESULT SetMaxPressure ([in] long iMaxPressure,[out, retval] long *result)
 Set the pressure range for a tablet.
HRESULT SetPadSerial ([in] SAFEARRAY(BYTE)*psaPadSerial,[out, retval] long *result)
 Query the tablet serial identification.
HRESULT SetResolution ([in] long iResolution,[out, retval] long *result)
 Set the logical resolution for a tablet.
HRESULT SetSampleRate ([in] long iSampleRate,[out, retval] long *result)
 Set the logical sample rate for a tablet.
HRESULT SetTabletOption ([in] BSTR bstrName,[in] long iValue,[out, retval] long *result)
 Set a tablet parameter.
HRESULT SetTabletSize ([in] long iWidth,[in] long iHeight,[out, retval] long *result)
 Set the tablet size.
HRESULT SetTicket ([in] ISPTicket *pTicket,[out, retval] long *result)
 Pass charged ticket for a capture operation.
HRESULT SwitchIDType ([in] long iSerialType,[out, retval] long *result)
 Choose the type of device ID returned by GetPadSerial().

Member Function Documentation

HRESULT ACTIVESWLib::ISPTablet::Acquire (  [in] __int64  hwndParent,
[out, retval] long *  result
) 
 

Start acquiry mode.

Set acquiry mode and send all vectors from the tablet to the registered listener.
All 0-pressure vectors are sent, if SP_ACQUIRE_TRANSFER_0_VECTORS is set, else only one 0-pressure vector is passed.
The function will return immediately if SP_ACQUIRE_RETURN_IMMEDIATELY is set, else SPTabletAcquire will return after SPAcquireDone was called.

Parameters:
hwndParent [i] Parent window handle, may be NULL.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletCreate, SPTabletAcquireDone

SPTabletSetFlags, SP_ACQUIRE_TRANSFER_0_VECTORS, SP_ACQUIRE_RETURN_IMMEDIATELY

HRESULT ACTIVESWLib::ISPTablet::Acquire32 (  [in] __int32  hwndParent,
[out, retval] long *  result
) 
 

Start acquiry mode.

Set acquiry mode and send all vectors from the tablet to the registered listener.
All 0-pressure vectors are sent, if SP_ACQUIRE_TRANSFER_0_VECTORS is set, else only one 0-pressure vector is passed.
The function will return immediately if SP_ACQUIRE_RETURN_IMMEDIATELY is set, else SPTabletAcquire will return after SPAcquireDone was called.

Note:
This method is exclusively for 32-bit applications, it will return an error (SP_PARAMERR) in a 64-bit process
Parameters:
hwndParent [i] Parent window handle, may be NULL.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletCreate, SPTabletAcquireDone

SPTabletSetFlags, SP_ACQUIRE_TRANSFER_0_VECTORS, SP_ACQUIRE_RETURN_IMMEDIATELY

HRESULT ACTIVESWLib::ISPTablet::AcquireDone (  [out, retval] long *  result  ) 
 

Terminate acquiry mode.

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletCreate, SPTabletAcquire, SPTabletGetSampleRate

SPSignatureSetSampleRate

HRESULT ACTIVESWLib::ISPTablet::ClearBackgroundImage (  [in] long  iImFlags,
[out, retval] long *  result
) 
 

Clear the backgound image.

Parameters:
iImFlags [i] image destination, either SP_ACTIVE_IMAGE or SP_IDLE_IMAGE or SP_IMMEDIATE_IMAGE
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPTabletClearBackgroundImage

HRESULT ACTIVESWLib::ISPTablet::Connect (  [out, retval] long *  result  ) 
 

Connect with a tablet.

Setup a connection to a tablet.

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletCreate, SPTabletDisconnect

HRESULT ACTIVESWLib::ISPTablet::CreateTablet (  [in] long  iDriverId,
[out, retval] long *  result
) 
 

Create a new tablet structure.

Please read Tablet creation options

Parameters:
iDriverId [i] identifier for the selected driver, pass SPX_UNKNOWN_DRV to use any driver, see SPTabletDriver
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletFree

SP_UNKNOWN_DRV , SP_PADCOM_DRV , SP_WINTAB_DRV, SP_NATIVE_DRV, SP_TCP_DRV

SPTabletDriver

HRESULT ACTIVESWLib::ISPTablet::CreateTabletByAlias (  [in] BSTR  bstrTabletAlias,
[out, retval] long *  result
) 
 

Create a new tablet structure based on an Alias.

Please read Tablet creation options for resolving the Alias

Parameters:
bstrTabletAlias [i] alias name of the desired tablet
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletFree

SPTabletCreateByAlias

HRESULT ACTIVESWLib::ISPTablet::CreateTabletByEnum (  [in] ISPPropertyMap *  spDescriptor,
[out, retval] long *  result
) 
 

create a tablet by an enumeration

Please read Tablet creation options for enumerating tablets

Note:
This function creates a default tablet if spDescriptor is NULL.
Parameters:
spDescriptor [i] descriptor of the desired tablet.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPTabletCreateByEnum, Disconnect

ConnectByEnum

HRESULT ACTIVESWLib::ISPTablet::CreateTabletEx (  [in] BSTR  bstrTabletClass,
[in] BSTR  bstrConfig,
[out, retval] long *  result
) 
 

Create a new tablet structure.

Please read Tablet creation options for a list of supported options

Parameters:
bstrTabletClass [i] class name of Kofax tablet access module.
bstrConfig [i] pass optional configuration data. Configuration data depends on the detected hardware driver, see Installation and configuration of various pads
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletFree

SPTabletCreateEx

HRESULT ACTIVESWLib::ISPTablet::Disconnect (  [out, retval] long *  result  ) 
 

Disconnect a tablet.

Terminate a connection to a tablet.

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletCreate, SPTabletConnect

HRESULT ACTIVESWLib::ISPTablet::GetDevice (  [out] long *  piDevice,
[out, retval] long *  result
) 
 

Query the device from a tablet.

Note:
Wacom drivers do not pass information about the connected devices, the detected device may differ from the physically connected device.
Todo:
Improve device detection.
Parameters:
piDevice [o] pointer to an SPINT32 that will be filled with the device tag from pTablet, see SPTabletDevice
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletSetDevice

HRESULT ACTIVESWLib::ISPTablet::GetDeviceStr (  [in] long  iDevice,
[out] BSTR *  bstrDevice,
[out, retval] long *  result
) 
 

Query the device name.

Parameters:
iDevice [i] the device ID that should be converted to a string
bstrDevice [o] Pointer to a BSTR that will be filled with the device name
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPTabletGetDeviceStr

HRESULT ACTIVESWLib::ISPTablet::GetDisplayType (  [out] long *  piDisplayType,
[out, retval] long *  result
) 
 

Query the display type of the tablet used by this SPTablet object.

SPTablet differentiates 3 types of tablet displays

  • SP_TABLET_NO_DISPLAY: tablets without a screen (such as Wacom Intuos)
  • SP_TABLET_LCD_DISPLAY: tablets with an integrated LCD screen (such as Wacom Signpad)
  • SP_TABLET_PC_DISPLAY: PCs with integrated tablet functionality (such as TabletPC)
Parameters:
piDisplayType [o] pointer to a variable that will be filled with the display type of the tablet
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetDisplayType, SPTabletSetDisplayType, SetDisplayType, SPTabletDisplay
Since:
Version 2.5

HRESULT ACTIVESWLib::ISPTablet::GetDriver (  [out] long *  piDriver,
[out, retval] long *  result
) 
 

Query the driver from a tablet.

Parameters:
piDriver [o] pointer to an SPINT32 that will be filled with the driver tag from pTablet, see SPTabletDriver
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetDriver

HRESULT ACTIVESWLib::ISPTablet::GetDriverStr (  [in] long  iDriver,
[out] BSTR *  bstrDriver,
[out, retval] long *  result
) 
 

Query the driver name.

Parameters:
iDriver [i] the driver ID that should be converted to a string
bstrDriver [o] Pointer to a BSTR that will be filled with the driver name
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPTabletGetDriverStr

HRESULT ACTIVESWLib::ISPTablet::GetFlags (  [out] long *  piFlags,
[out, retval] long *  result
) 
 

Query the tablet flags during acquiry mode.

Parameters:
piFlags [o] a pointer that will be filled with the acquiry flags, see SetFlags
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetFlags, SetFlags

SP_ACQUIRE_TRANSFER_0_VECTORS, SP_ACQUIRE_RETURN_IMMEDIATELY, SP_DONT_ECHO_STROKES

HRESULT ACTIVESWLib::ISPTablet::GetHardwareName (  [out] BSTR *  bstrHardwareName,
[out, retval] long *  result
) 
 

Get the hardware file name of an SPTablet object.

Parameters:
bstrHardwareName [o] pointer to a BSTR that will be filled with the hardware file name from the SPTablet object.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTabletGetHardwareName
Since:
Version 2.5

HRESULT ACTIVESWLib::ISPTablet::GetLCD (  [out] long *  piLCD,
[out, retval] long *  result
) 
 

Get the tablet LCD mode during acquiry mode.

Parameters:
piLCD [o] a pointer to SPINT32 that receives the actual mode setting, 0: no LCD device, 1 LCD device.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
GetDisplayType
Deprecated:
This function is replaced by ACTIVESWLib::ISPTablet::GetDisplayType

HRESULT ACTIVESWLib::ISPTablet::GetLCDBitsPerPixel (  [out] long *  piBits,
[out, retval] long *  result
) 
 

Query bits per pixel of the attached LCD screen in pixel.

Parameters:
piBits [o] pointer to an SPINT32 that will be filled with the bits per pixel of the LCD screen in pixel
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetLCDBitsPerPixel, SetBackgroundImage

HRESULT ACTIVESWLib::ISPTablet::GetLCDSize (  [out] long *  piWidth,
[out] long *  piHeight,
[out, retval] long *  result
) 
 

Query size of the attached LCD screen in pixel.

Parameters:
piWidth [o] pointer to an SPINT32 that will be filled with the width of the LCD screen in pixel
piHeight [o] pointer to an SPINT32 that will be filled with the height of the LCD screen in pixel
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetLCDSize, SetBackgroundImage

HRESULT ACTIVESWLib::ISPTablet::GetMaxPressure (  [out] long *  piMaxPressure,
[out, retval] long *  result
) 
 

Query the pressure range from a tablet.

Parameters:
piMaxPressure [o] pointer to an SPINT32 that will be filled with the max pressure tag from pTablet
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletSetMaxPressure

HRESULT ACTIVESWLib::ISPTablet::GetPadSerial (  [out] SAFEARRAY(BYTE)*  psaPadSerial,
[out, retval] long *  result
) 
 

Query the tablet serial identification.

Parameters:
psaPadSerial [o] pointer to a safe array that will be filled with the tablet serial identification
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetPadSerial

HRESULT ACTIVESWLib::ISPTablet::GetPhysicalSize (  [out] long *  piWidth,
[out] long *  piHeight,
[out, retval] long *  result
) 
 

Query the tablet size from a tablet [in mm].

Parameters:
piWidth [o] pointer to an SPINT32 that will be filled with the width of the Tablet
piHeight [o] pointer to an SPINT32 that will be filled with the height of the Tablet
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
Note:
mm = tablet coordinate / (SPTabletGetResolution(pTablet) * 25.4).
See also:
SPTabletGetPhysicalSize

HRESULT ACTIVESWLib::ISPTablet::GetResolution (  [out] long *  piResolution,
[out, retval] long *  result
) 
 

Query the logical resolution from a tablet.

Parameters:
piResolution [o] pointer to an SPINT32 that will be filled with the resolution tag from pTablet
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetResolution, GetResolution2, SetResolution

HRESULT ACTIVESWLib::ISPTablet::GetResolution2 (  [in] long  lDetail,
[out] long *  piResolution,
[out, retval] long *  result
) 
 

Query the resolution from a tablet.

Parameters:
lDetail [i] query the physical (SPX_TABLET_PHYSICAL) or logical (SPX_TABLET_LOGICAL) resolution
piResolution [o] pointer to an SPINT32 that will be filled with the resolution tag from pTablet
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetResolution2
Since:
Version 3.2.2

HRESULT ACTIVESWLib::ISPTablet::GetSampleRate (  [out] long *  piSampleRate,
[out, retval] long *  result
) 
 

Query the logical Sample Rate from a tablet.

Parameters:
piSampleRate [o] pointer to an SPINT32 that will be filled with the sample rate tag from pTablet
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetSampleRate, GetSampleRate2, SetSampleRate

HRESULT ACTIVESWLib::ISPTablet::GetSampleRate2 (  [in] long  lDetail,
[out] long *  piSampleRate,
[out, retval] long *  result
) 
 

Query the Sample Rate from a tablet.

Parameters:
lDetail [i] query the physical (SPX_TABLET_PHYSICAL) or logical (SPX_TABLET_LOGICAL) sample rate
piSampleRate [o] pointer to an SPINT32 that will be filled with the sample rate tag from pTablet
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetSampleRate2
Since:
Version 3.2.2

HRESULT ACTIVESWLib::ISPTablet::GetState (  [out] long *  piState,
[out, retval] long *  result
) 
 

Query the tablet state.

Parameters:
piState [o] a pointer that will be filled with the actual state, see SPTabletState
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetState

HRESULT ACTIVESWLib::ISPTablet::GetTabletSize (  [out] long *  piWidth,
[out] long *  piHeight,
[out, retval] long *  result
) 
 

Query the tablet size from a tablet [in tablet coordinates].

Parameters:
piWidth [o] pointer to an SPINT32 that will be filled with the width tag from pTablet
piHeight [o] pointer to an SPINT32 that will be filled with the height tag from pTablet
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
Note:
mm = tablet coordinate / (SPTabletGetResolution(pTablet) * 25.4).
See also:
SPTabletSetTabletSize

HRESULT ACTIVESWLib::ISPTablet::GetTabletType (  [out] long *  piType,
[out, retval] long *  result
) 
 

Query the tablet type.

Parameters:
piType [o] pointer to an SPINT32 that will be filled with the tablet type from pTablet, see SPTabletType
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletGetTabletType
Since:
Version 2.5

HRESULT ACTIVESWLib::ISPTablet::GetTimeStamp (  [out] long *  piTimeStamp,
[out, retval] long *  result
) 
 

Query the timestamp of the last acquired signature.

Parameters:
piTimeStamp [o] a pointer to an int that will be filled with the timestamp of the last acquired signature.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletCreate

SPTabletAcquire

HRESULT ACTIVESWLib::ISPTablet::HasExternalLCD (  [out] long *  pbExternalLCD,
[out, retval] long *  result
) 
 

Query if the tablet is a model with external LCD.

Parameters:
pbExternalLCD [o] ointer to a flag that will be filled with the ExternalLCD property. pbExternalLCD will be set to 1 if the model has an external LCD, else it will be set to 0.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
GetDisplayType
Deprecated:
This function is replaced by ACTIVESWLib::ISPTablet::GetDisplayType

HRESULT ACTIVESWLib::ISPTablet::HasProximity (  [out] long *  piProximity,
[out, retval] long *  result
) 
 

Query proximity of the tablet.

Parameters:
piProximity [o] pointer to an integer that will be filled with the proximity capability of the connected tablet. return:
  • 0: Tablet cannot send vector coordinates when pen is raised
  • 1: Tablet can send vector coordinates when pen is raised (less than 5 mm)
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
Note:
Devices that do not support proximity cannot send the actual pen position as long as the pen is up. Special care must therefore be taken, when drawing the first non 0-pressure vector. The SPTablet object will insert a 0-pressure vector with the coordinates of the first non 0-pressure vector to inform all listeners on the actual pen position for these devices.

HRESULT ACTIVESWLib::ISPTablet::ReloadParameters (  [out, retval] long *  result  ) 
 

Reload the tablet parameters.

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTabletReloadParameters
Since:
Version 2.5

HRESULT ACTIVESWLib::ISPTablet::Reset (  [in] long  bReset,
[out, retval] long *  result
) 
 

Reset the tablet driver.

Parameters:
bReset [i] must be TRUE
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPTabletReset

HRESULT ACTIVESWLib::ISPTablet::SetBackgroundImage (  [in] SAFEARRAY(BYTE)*  pszImage,
[out, retval] long *  result
) 
 

Pass a backgound image.

Parameters:
pszImage,: [i] byte array with one dimension and arbitrary length
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPTabletSetBackgroundImage

HRESULT ACTIVESWLib::ISPTablet::SetBackgroundImage2 (  [in] long  iImFlags,
[in] SAFEARRAY(BYTE)*  pszImage,
[out, retval] long *  result
) 
 

Pass a backgound image.

Parameters:
iImFlags [i] image destination, either SPX_ACTIVE_IMAGE or SPX_IDLE_IMAGE or SPX_IMMEDIATE_IMAGE
pszImage [i] byte array with one dimension and arbitrary length
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPTabletSetBackgroundImage2, SPTabletBackgroundImage

HRESULT ACTIVESWLib::ISPTablet::SetClipRectangle (  [in] long  iLeft,
[in] long  iTop,
[in] long  iRight,
[in] long  iBottom,
[out, retval] long *  result
) 
 

Set the clipping rectangle for the tablet display.

Parameters:
iLeft [i] left coordinate of the signature entry region, in ppm (1/1000, thousands)
iTop [i] top coordinate of the signature entry region, in ppm (1/1000, thousands)
iRight [i] right coordinate of the signature entry region, in ppm (1/1000, thousands)
iBottom [i] bottom coordinate of the signature entry region, in ppm (1/1000, thousands)
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else error code
Note:
Strokes out of the clipping rectangle will not be drawn on the tablet screen.
Currently only supported on Signpad STU-520
Since:
Version 2.6.1

HRESULT ACTIVESWLib::ISPTablet::SetDevice (  [in] long  iDevice,
[out, retval] long *  result
) 
 

Set the device id for a tablet.

Note:
The device ID is set during initialization and should not be overwritten unless you know what you do.
Parameters:
iDevice [i] Device identifier, see SPTabletDevice
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletCreate

SPTabletGetDevice

HRESULT ACTIVESWLib::ISPTablet::SetDisplayType (  [in] long  iDisplayType,
[out, retval] long *  result
) 
 

Set the display type of the tablet used by this SPTablet object.

SPTablet differentiates 3 types of tablet displays

  • SP_TABLET_NO_DISPLAY: tablets without a screen (such as Wacom Intuos)
  • SP_TABLET_LCD_DISPLAY: tablets with an integrated LCD screen (such as Wacom Signpad)
  • SP_TABLET_PC_DISPLAY: PCs with integrated tablet functionality (such as TabletPC)
Parameters:
iDisplayType [i] the display type of the tablet
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else error code
See also:
SPTabletCreate

SPTabletGetDisplayType, SPTabletSetDisplayType, GetDisplayType, SPTabletDisplay

Since:
Version 2.5

HRESULT ACTIVESWLib::ISPTablet::SetDriver (  [in] long  iDriver,
[out, retval] long *  result
) 
 

Set the driver for a tablet.

Note:
The driver ID is set during initialization and should not be overwritten unless you know what you do.
Parameters:
iDriver [i] driver identifier, see SPTabletDriver
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletCreate

SPTabletGetDriver

HRESULT ACTIVESWLib::ISPTablet::SetFlags (  [in] long  iFlags,
[out, retval] long *  result
) 
 

Set the tablet flags during acquiry mode.

Parameters:
iFlags [i] a bitwise combination of flags :
  • SP_ACQUIRE_TRANSFER_0_VECTORS
  • SP_ACQUIRE_RETURN_IMMEDIATELY
  • SP_DONT_ECHO_STROKES
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletSetListeners, SPTabletSetFlags, GetFlags

SP_ACQUIRE_TRANSFER_0_VECTORS, SP_ACQUIRE_RETURN_IMMEDIATELY, SP_DONT_ECHO_STROKES

HRESULT ACTIVESWLib::ISPTablet::SetLCD (  [in] long  iLCD,
[out, retval] long *  result
) 
 

Set the tablet LCD mode during acquiry mode.

Note:
The LCD mode is set during initialization and should not be overwritten unless you know what you do.
Parameters:
iLCD [i] an SPINT32 indicating the desired mode setting, 0: no LCD device, 1 LCD device.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletCreate

SetDisplayType

Deprecated:
This function is replaced by ACTIVESWLib::ISPTablet::SetDisplayType

HRESULT ACTIVESWLib::ISPTablet::SetMaxPressure (  [in] long  iMaxPressure,
[out, retval] long *  result
) 
 

Set the pressure range for a tablet.

Parameters:
iMaxPressure [i] max. pressure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
Note:
The max. pressure is set during initialization and should not be overwritten unless you know what you do.
See also:
SPTabletCreate

SPTabletGetMaxPressure

HRESULT ACTIVESWLib::ISPTablet::SetPadSerial (  [in] SAFEARRAY(BYTE)*  psaPadSerial,
[out, retval] long *  result
) 
 

Query the tablet serial identification.

Parameters:
psaPadSerial [i] pointer to a safe array that contains the tablet serial identification
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletSetPadSerial

HRESULT ACTIVESWLib::ISPTablet::SetResolution (  [in] long  iResolution,
[out, retval] long *  result
) 
 

Set the logical resolution for a tablet.

Note:
The resolution is set during initialization and should not be overwritten unless you know what you do.
Parameters:
iResolution [i] Resolution
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletSetResolution, GetResolution2

HRESULT ACTIVESWLib::ISPTablet::SetSampleRate (  [in] long  iSampleRate,
[out, retval] long *  result
) 
 

Set the logical sample rate for a tablet.

Parameters:
iSampleRate [i] sample rate
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
Note:
The sample rate is set during initialization and should not be overwritten unless you know what you do.
Todo:
Wacom wintab driver ignores the Sample Rate parameter.
Solution: Wait for a Wacom wintab driver, that supports sample rate adjustment.
See also:
SPTabletCreate

SPTabletSetSampleRate

HRESULT ACTIVESWLib::ISPTablet::SetTabletOption (  [in] BSTR  bstrName,
[in] long  iValue,
[out, retval] long *  result
) 
 

Set a tablet parameter.

For details please see SPTabletSetTabletOption

Parameters:
bstrName [i] the name / identifier of the option to set, must be one of the following:
  • "BackgroundColor" the background color of the tablet display
    Currently only supported on Signpad STU-520
  • "ForegroundColor" the foreground color of the tablet display, pen strokes are drawn in foreground color
    Currently only supported on Signpad STU-520
  • "PenThickness" Pen thickness is used to render strokes on the tablet LCD.
    Currently only supported on Signpad STU-520
iValue [i] Value of the addressed option
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else error code
Note:
Options can only be passed to the tablet when the tablet is in state SP_TABLET_STATE_CONNECT.
Since:
Version 2.6.1

HRESULT ACTIVESWLib::ISPTablet::SetTabletSize (  [in] long  iWidth,
[in] long  iHeight,
[out, retval] long *  result
) 
 

Set the tablet size.

Parameters:
iWidth [i] tablet width [in tablet coordinates]
iHeight [i] tablet height [in tablet coordinates]
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
Note:
The tablet size is set during initialization and should not be overwritten unless you know what you do.

mm = tablet coordinate / (SPTabletGetResolution(pTablet) * 25.4).

See also:
SPTabletCreate

SPTabletGetTabletSize

HRESULT ACTIVESWLib::ISPTablet::SetTicket (  [in] ISPTicket *  pTicket,
[out, retval] long *  result
) 
 

Pass charged ticket for a capture operation.

Parameters:
pTicket [i] ticket
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Deprecated:
Use ACTIVESWLib::ISPSignware::SetTicket instead

HRESULT ACTIVESWLib::ISPTablet::SwitchIDType (  [in] long  iSerialType,
[out, retval] long *  result
) 
 

Choose the type of device ID returned by GetPadSerial().

Parameters:
iSerialType [i] type of ID to return
See also:
SP_TABLET_SERIAL_TYPE_DEFAULT

SP_TABLET_SERIAL_TYPE_CUSTOM

SP_TABLET_SERIAL_TYPE_FACTORY

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
S_OK success, else error code
errors:
See also:
SPTabletCreate

The documentation for this interface was generated from the following file: