visit Kofax web site
ACTIVESWLib::ISPTellerImage

ACTIVESWLib::ISPTellerImage Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPTellerImageInterface ISPTellerImage.

Representation of a Teller image


Public Member Functions

HRESULT CreateFromImage ([in] ISPImage *pImage,[out, retval] long *result)
 Create a TellerImage Object from an image.
HRESULT CreateFromReference ([in] ISPReference *pReference,[out, retval] long *result)
 Create a TellerImage Object from a reference.
HRESULT CreateFromSignature ([in] ISPSignature *pSignature,[out, retval] long *result)
 Create a TellerImage Object from a signature.
HRESULT CreateFromXML ([in] SAFEARRAY(BYTE)*xml,[out, retval] long *result)
 Create a TellerImage Object from an image.
HRESULT GetSource ([out] char *pchSource,[out, retval] long *result)
 Query the image source.
HRESULT GetType ([out] char *pchType,[out, retval] long *result)
 Query the image type.
HRESULT GetXML ([in] long iIndent,[out] SAFEARRAY(BYTE)*pXML,[out, retval] long *result)
 Convert a TellerImage Object to a XML string that confirms with signplus.dtd.
HRESULT SetSource ([in] char chSource,[out, retval] long *result)
 Set the image source.

Member Function Documentation

HRESULT ACTIVESWLib::ISPTellerImage::CreateFromImage (  [in] ISPImage *  pImage,
[out, retval] long *  result
) 
 

Create a TellerImage Object from an image.

Parameters:
pImage [i] The image object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
See also:
SPTellerImageCreateFromImage

HRESULT ACTIVESWLib::ISPTellerImage::CreateFromReference (  [in] ISPReference *  pReference,
[out, retval] long *  result
) 
 

Create a TellerImage Object from a reference.

Parameters:
pReference [i] The reference object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
See also:
SPTellerImageCreateFromReference

HRESULT ACTIVESWLib::ISPTellerImage::CreateFromSignature (  [in] ISPSignature *  pSignature,
[out, retval] long *  result
) 
 

Create a TellerImage Object from a signature.

Parameters:
pSignature [i] The signature object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
See also:
SPTellerImageCreateFromSignature

HRESULT ACTIVESWLib::ISPTellerImage::CreateFromXML (  [in] SAFEARRAY(BYTE)*  xml,
[out, retval] long *  result
) 
 

Create a TellerImage Object from an image.

Parameters:
xml [i] the xml data stream
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
See also:
SPTellerImageCreateFromImage

HRESULT ACTIVESWLib::ISPTellerImage::GetSource (  [out] char *  pchSource,
[out, retval] long *  result
) 
 

Query the image source.

Parameters:
pchSource [o] a pointer to a char that will be filled with the image source, see SPTellerImageGetSource for details
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
  • SP_UNSUPPORTEDERR unsupported image type
Returns:
automation result
See also:
SPTellerImageGetSource

HRESULT ACTIVESWLib::ISPTellerImage::GetType (  [out] char *  pchType,
[out, retval] long *  result
) 
 

Query the image type.

Parameters:
pchType [o] pointer to a char, that will be filled with the image type, see SPTellerImageGetType for details
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
  • SP_UNSUPPORTEDERR unsupported image type
Returns:
automation result
See also:
SPTellerImageGetType

HRESULT ACTIVESWLib::ISPTellerImage::GetXML (  [in] long  iIndent,
[out] SAFEARRAY(BYTE)*  pXML,
[out, retval] long *  result
) 
 

Convert a TellerImage Object to a XML string that confirms with signplus.dtd.

Parameters:
iIndent [i] number of spaces to indent, may be 0
pXML [i] pointer to a BSTR that will be filled with the XML representation
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
  • SP_UNSUPPORTEDERR unsupported image type
Returns:
automation result
See also:
SPTellerImageGetXML

HRESULT ACTIVESWLib::ISPTellerImage::SetSource (  [in] char  chSource,
[out, retval] long *  result
) 
 

Set the image source.

Parameters:
chSource [i] the image source, see SPTellerImageSetSource for details
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
  • SP_UNSUPPORTEDERR unsupported image type
Returns:
automation result
See also:
SPTellerImageSetSource

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