visit Kofax web site
ACTIVESWLib::ISPBackgroundObjects

ACTIVESWLib::ISPBackgroundObjects Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPBackgroundObjects.

Author:
uko
The ActiveX component extends the C-API according to the specification of Microsoft OLE COM ActiveX technology.

Representation of tablet background descriptors

Please see sec_SignWareDTD for a full description of all background elements, see SPBackgroundObjects.h for details of the core implementation


Public Member Functions

HRESULT CreateFromFile ([in] BSTR bstrFile,[in] BSTR bstrLanguage,[out, retval] long *result)
 Create a background descriptor container object.
HRESULT CreateFromXML ([in] BSTR bstrXML,[out, retval] long *result)
 Create a background descriptor container object.
HRESULT CreateFromXMLBytes ([in] ISPFlatFile *pFlatFile,[out, retval] long *result)
 Create a background descriptor container object.

Member Function Documentation

HRESULT ACTIVESWLib::ISPBackgroundObjects::CreateFromFile (  [in] BSTR  bstrFile,
[in] BSTR  bstrLanguage,
[out, retval] long *  result
) 
 

Create a background descriptor container object.

Note:
the file must contain a valid xml description for the tablet background, the root element must be SPSWDeviceFields, see sec_SignWareDTD
Parameters:
bstrFile [i] name of the file to read. If the filename is a fully qualified path then this path will be read. Else under Windows the file will be located in:
  • %USERPROFILE%\SOFTPRO
  • %USERPROFILE%
  • %HOMEPATH%\SOFTPRO
  • %HOMEPATH%
  • %ALLUSERSPROFILE%\SOFTPRO
  • %ALLUSERSPROFILE%
  • %APPDATA%\SOFTPRO
  • %APPDATA%
  • %PATH%
  • SystemDirectory, only Windows
  • WindowsDirectory, only Windows
bstrLanguage [i] two-digit language code, e. g. "en" for english, may be NULL
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:
SPBackgroundObjectsCreateFromFile, ISPAcquire::SetBackgroundObjects, ISPGuiAcqu::SetBackgroundObjects

HRESULT ACTIVESWLib::ISPBackgroundObjects::CreateFromXML (  [in] BSTR  bstrXML,
[out, retval] long *  result
) 
 

Create a background descriptor container object.

Note:
the XML string must contain a valid xml description for the tablet background, the root element must be SPSWDeviceFields, see sec_SignWareDTD
Parameters:
bstrXML [i] the xml string, supported encodings in the XML declaration is UTF-8
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:
SPBackgroundObjectsCreateFromXML, ISPAcquire::SetBackgroundObjects, ISPGuiAcqu::SetBackgroundObjects

HRESULT ACTIVESWLib::ISPBackgroundObjects::CreateFromXMLBytes (  [in] ISPFlatFile *  pFlatFile,
[out, retval] long *  result
) 
 

Create a background descriptor container object.

Note:
the XML string must contain a valid xml description for the tablet background, the root element must be SPSWDeviceFields, see sec_SignWareDTD
Parameters:
pFlatFile [i] the zero terminated xml string as a byte array, supported encodings in the XML declaration are ASCII, UTF-8 and ISO-8859-1
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:
SPBackgroundObjectsCreateFromXML, ISPAcquire::SetBackgroundObjects, ISPGuiAcqu::SetBackgroundObjects

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