visit Kofax web site

SPTabletEnum.h File Reference

Detailed Description

SignWare Dynamic Development toolkit, tablet enumeration.

Author:
uko
The object SPTabletEnum enumerates tablets for either a specific tablet class or all tablet classes. You may use an enumeration object to create the specific tablet,
See also:
SPTabletCreateByEnum.
SPTabletEnum enumerates all devices in these tablet classes: All drivers are loaded and queried for the list of devices when SPTabletEnum is instantiated the first time. The drivers will not be unloaded until the application is closed or SPTabletReset is called.
Successive instances will update the device list to reflect the actual state (dynamically update the device list).
Some device drivers have long timeouts before they return with 'no device found'. It is thus recommended to create a SPTabletEnum object when the application starts. The object may be freed immediately, subsequent calls use static objects which are only deleted when calling SPTabletReset or when exiting the application.

Since:
Version 3.2


Functions

SPINT32 __cdecl SPTabletEnumClone (pSPTABLETENUM_T pTabletEnum, pSPTABLETENUM_T *ppCopy)
SPINT32 __cdecl SPTabletEnumCreate (pSPTABLETENUM_T *ppTabletEnum)
SPINT32 __cdecl SPTabletEnumCreateByClass (pSPTABLETENUM_T *ppTabletEnum, const char *pszClass)
SPINT32 __cdecl SPTabletEnumFree (pSPTABLETENUM_T *ppTabletEnum)
SPINT32 __cdecl SPTabletEnumGetDescriptor (pSPTABLETENUM_T pTabletEnum, SPINT32 iIndex, pSPPROPERTYMAP_T *ppDescriptor)
SPINT32 __cdecl SPTabletEnumGetNumberTablets (pSPTABLETENUM_T pTabletEnum, SPINT32 *piTablets)

Function Documentation

SPINT32 __cdecl SPTabletEnumClone (  pSPTABLETENUM_T  pTabletEnum,
pSPTABLETENUM_T *  ppCopy
) 
 

Clone a tablet enumerator

Parameters:
pTabletEnum [i] pointer to valid SPTabletEnum object
ppCopy [o] pointer to variable that will be filled with an pointer to the copied SPTabletEnum object. The caller is responsible for deallocating the new object by calling SPTabletEnumFree
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Since:
Version 3.2

SPINT32 __cdecl SPTabletEnumCreate (  pSPTABLETENUM_T *  ppTabletEnum  ) 
 

Create a tablet enumerator

Parameters:
ppTabletEnum [o] pointer to variable that will be filled with an pointer to the new SPTabletEnum object. The caller is responsible for deallocating the new object by calling SPTabletEnumFree
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Since:
Version 3.2

SPINT32 __cdecl SPTabletEnumCreateByClass (  pSPTABLETENUM_T *  ppTabletEnum,
const char *  pszClass
) 
 

Create a tablet enumerator

Note:
Tablet enumeration is currently supported by these tablet classes:
  • SPTabletWSignPad SignPad family
  • SPTabletWintab most Wacom tablets (restriced to one device)
  • SPTabletStepover Stepover tablets (restricted to one device)
  • SPTabletTopaz Topaz tablets (restricted to one device)
  • SPTabletWTablet TabletPC
  • SPTabletRemoteTablet remote devices such as smart phones
  • SPGenericTablet devices which are accessed via the generic tablet interface
Parameters:
ppTabletEnum [o] pointer to variable that will be filled with an pointer to the new SPTabletEnum object. The caller is responsible for deallocating the new object by calling SPTabletEnumFree
pszClass [i] optional name of the tablet class to enumerate. This call equals SPTabletEnumCreate if pszClass is NULL.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Since:
Version 3.2

SPINT32 __cdecl SPTabletEnumFree (  pSPTABLETENUM_T *  ppTabletEnum  ) 
 

Deallocate a tablet enumerator object

Parameters:
ppTabletEnum [io] pointer to variable containing a pointer to a valid SPTabletEnum object. The variable will be set to NULL if the function succeeds.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Since:
Version 3.2

SPINT32 __cdecl SPTabletEnumGetDescriptor (  pSPTABLETENUM_T  pTabletEnum,
SPINT32  iIndex,
pSPPROPERTYMAP_T *  ppDescriptor
) 
 

Query a descriptor for an enumerated tablet

Parameters:
pTabletEnum [i] pointer to valid SPTabletEnum object
iIndex [i] zero based index of the device
ppDescriptor [o] pointer to a variable that will be filled with a pointer to a SPPropertyMap object. The property map contains these keys:
  • Class: [string] name of the tablet class
  • Manufacturer: [string] name of the manufacturer
  • Model: [string] tablet model
  • Modul: [string] name of the tablet access module
  • Name: [string] name of the tablet
  • Paired: [boolean] true: the tablet is connected / accessible, else the tablet may not be accessible
The caller is responsible for deallocating the descriptor by calling SPPropertyMapFree
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Since:
Version 3.2

SPINT32 __cdecl SPTabletEnumGetNumberTablets (  pSPTABLETENUM_T  pTabletEnum,
SPINT32 *  piTablets
) 
 

Query the number of tablets in this enumeration object

Parameters:
pTabletEnum [i] pointer to valid SPTabletEnum object
piTablets [o] pointer to an integer that will be filled with the number of tablets contained in this enumeration object
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Since:
Version 3.2