visit Kofax web site

ACTIVESWLib::ISPTabletEnum Interface Reference


Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPTabletEnumInterface ISPTabletEnum.

Representation of tablet enumeration

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:
ISPTablet.CreateTabletByEnum.
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 ISPTablet.Reset 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 ISPTablet.Reset or when exiting the applition.


Public Member Functions

HRESULT CreateByClass ([in] BSTR bstrClassName,[out, retval] long *result)
 Create a tablet enum object.
HRESULT GetDescriptor ([in] long lIndex,[out] ISPPropertyMap **ppDescriptor,[out, retval] long *result)
 Query the descriptor for a tablet in this enumeration.
HRESULT GetNumberTablets ([out] long *plNumberTablets,[out, retval] long *result)
 Query the number of tablets in this enumeration.


Member Function Documentation

HRESULT ACTIVESWLib::ISPTabletEnum::CreateByClass [in] BSTR  bstrClassName,
[out, retval] long *  result
 

Create a tablet enum object.

Parameters:
bstrClassName [i] the tablet class name for the enumeration
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:
SPTabletEnumCreateByClass
Since:
Version 3.2

HRESULT ACTIVESWLib::ISPTabletEnum::GetDescriptor [in] long  lIndex,
[out] ISPPropertyMap **  ppDescriptor,
[out, retval] long *  result
 

Query the descriptor for a tablet in this enumeration.

Parameters:
lIndex [i] zero based index
ppDescriptor [o] pointer to a ISPPropertyMap wich will be filled with the tablet descriptor
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:
SPTabletEnumGetDescriptor
Since:
Version 3.2

HRESULT ACTIVESWLib::ISPTabletEnum::GetNumberTablets [out] long *  plNumberTablets,
[out, retval] long *  result
 

Query the number of tablets in this enumeration.

Parameters:
plNumberTablets [i] pointer to a long that will be filled with the number of tablets in this enumeration
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:
SPTabletEnumGetNumberTablets
Since:
Version 3.2


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