visit Kofax web site
ACTIVESWLib::ISPFlatFile

ACTIVESWLib::ISPFlatFile Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPFlatFileInterface ISPFlatFile.

Convert signatures / references or templates to a flatfile structure


Public Member Functions

HRESULT CreateFromBase64RawData ([in] BSTR bstrRawData,[out, retval] long *result)
 Create a flat file from a base64 encoded string.
HRESULT CreateFromCleanParameter ([in] ISPCleanParameter *pCleanParameter,[out, retval] long *result)
 Create a flat file from a valid clean parameter object.
HRESULT CreateFromImage ([in] ISPImage *pImage,[in] long lFormat,[out, retval] long *result)
 Create a flat file from a valid image object.
HRESULT CreateFromPropertyMap ([in] ISPPropertyMap *pPropertyMap,[out, retval] long *result)
 Create a flat file from a valid propertymap object.
HRESULT CreateFromRawData ([in] SAFEARRAY(BYTE)*pszRawData,[out, retval] long *result)
 Wrap the specified byte array.
HRESULT CreateFromReference ([in] ISPReference *pReference,[out, retval] long *result)
HRESULT CreateFromReference2 ([in] ISPReference *pReference,[in] long iFormat,[out, retval] long *result)
 Create a flat file object from a reference object.
HRESULT CreateFromReference3 ([in] ISPReference *pReference,[in] long iFormat,[out, retval] long *result)
 Create a flat file object from a reference object.
HRESULT CreateFromSignature ([in] ISPSignature *pSignature,[out, retval] long *result)
 Create a flat file object in SPX_FF_SOFTPRO format from a signature object.
HRESULT CreateFromSignature2 ([in] ISPSignature *pSignature,[in] long iFormat,[out, retval] long *result)
 Create a flat file object from a signature object.
HRESULT CreateFromSignature3 ([in] ISPSignature *pSignature,[in] long iFormat,[out, retval] long *result)
 Create a flat file object from a signature object.
HRESULT CreateFromTemplate ([in] ISPTemplate *pTemplate,[out, retval] long *result)
 Create a flat file from a valid template object.
HRESULT CreateFromTicket ([in] ISPTicket *pTicket,[out, retval] long *result)
 Create a flat file from a valid ticket object.
HRESULT GetBase64RawData ([out] BSTR *pbstrRawData,[out, retval] long *result)
 Create a flat file from a base64 encoded string.
HRESULT GetRawData ([out] SAFEARRAY(BYTE)*pszRawData,[out, retval] long *result)
 Extract the wrapped data.
HRESULT IsCleanParameter ([out, retval] long *result)
 check if a flat file structure contains a serialized CleanParameter
HRESULT IsPropertyMap ([out, retval] long *result)
 check if a flat file structure contains a serialized PropertyMap
HRESULT IsReference ([out, retval] long *result)
 check if a flat file structure contains a serialized reference
HRESULT IsSignature ([out, retval] long *result)
 check if a flat file structure contains a serialized signature
HRESULT IsTemplate ([out, retval] long *result)
 check if a flat file structure contains a serialized template
HRESULT IsTicket ([out, retval] long *result)
 check if a flat file structure contains a serialized ticket

Member Function Documentation

HRESULT ACTIVESWLib::ISPFlatFile::CreateFromBase64RawData (  [in] BSTR  bstrRawData,
[out, retval] long *  result
) 
 

Create a flat file from a base64 encoded string.

Parameters:
bstrRawData [i] The Base64 encoded raw data
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:
GetBase64RawData, CreateFromRawData
Note:
This function extends CreateFromRawData but passes a base64 encoded string.

HRESULT ACTIVESWLib::ISPFlatFile::CreateFromCleanParameter (  [in] ISPCleanParameter *  pCleanParameter,
[out, retval] long *  result
) 
 

Create a flat file from a valid clean parameter object.

Parameters:
pCleanParameter [i] pointer to an instance of ISPCleanParameter
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:
SPFlatFileCreateFromCleanParameter, ISPCleanParameter::Write

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

Create a flat file from a valid image object.

Parameters:
pImage [i] pointer to an instance of ISPImage
lFormat [i] format of the requested flatfile
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:
SPImageSaveInBitmap, SPImageTypes

HRESULT ACTIVESWLib::ISPFlatFile::CreateFromPropertyMap (  [in] ISPPropertyMap *  pPropertyMap,
[out, retval] long *  result
) 
 

Create a flat file from a valid propertymap object.

Parameters:
pPropertyMap [i] pointer to an instance of ISPPropertyMap
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:
SPFlatFileCreateFromPropertyMap, ISPPropertyMap::Write

HRESULT ACTIVESWLib::ISPFlatFile::CreateFromRawData (  [in] SAFEARRAY(BYTE)*  pszRawData,
[out, retval] long *  result
) 
 

Wrap the specified byte array.

Parameters:
pszRawData,: [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

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

HRESULT ACTIVESWLib::ISPFlatFile::CreateFromReference2 (  [in] ISPReference *  pReference,
[in] long  iFormat,
[out, retval] long *  result
) 
 

Create a flat file object from a reference object.

Flags can be specified by environment variable SIGNWARE_ISO_SAVE. Its value is either a decimal number or a hexadecimal number (prefixed by "0x"). The number will be shifted left 20 bits and bitwise or-ed into iFormat, that is, the following values (and combinations thereof) are defined:

Parameters:
pReference [i] pointer to an instance of ISPReference
iFormat [i] Format to be used: either one of the following constants: or a combination (bitwise or) of up to one constant from each of the following three groups: No flags can be specified in iFormat, but see CreateFromReference3. SPDynamicFormat::SPX_FF_ISO_19794_7_2007TC1 without SPDynamicFormat::SPX_FF_ISO_19785_3_FORMAT6, as well as SPDynamicFormat::SPX_FF_ISO_19794_MINIMUM and SPDynamicFormat::SPX_FF_ISO_19794_SIMPLE can be used only if the number of signatures is one.
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:
CreateFromReference, CreateFromReference3, SPFlatFileCreateFromReference2

HRESULT ACTIVESWLib::ISPFlatFile::CreateFromReference3 (  [in] ISPReference *  pReference,
[in] long  iFormat,
[out, retval] long *  result
) 
 

Create a flat file object from a reference object.

This function does not use environment variable SIGNWARE_ISO_SAVE.

Parameters:
pReference [i] pointer to an instance of ISPReference
iFormat [i] Format to be used: either one of the following constants: or a combination (bitwise or) of up to one constant from each of the following three groups: For some formats, you can additionally include (bitwise or) these flags: SPDynamicFormat::SPX_FF_ISO_19794_7_2007TC1 without SPDynamicFormat::SPX_FF_ISO_19785_3_FORMAT6, as well as SPDynamicFormat::SPX_FF_ISO_19794_MINIMUM and SPDynamicFormat::SPX_FF_ISO_19794_SIMPLE can be used only if the number of signatures is one.
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:
CreateFromReference, CreateFromReference2, SPFlatFileCreateFromReference3

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

Create a flat file object in SPX_FF_SOFTPRO format from a signature object.

This function uses flat file format SPDynamicFormat::SPX_FF_SOFTPRO.

Parameters:
pSignature [i] pointer to an instance of ISPSignature
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:
CreateFromSignature2, CreateFromSignature3, SPFlatFileCreateFromSignature

HRESULT ACTIVESWLib::ISPFlatFile::CreateFromSignature2 (  [in] ISPSignature *  pSignature,
[in] long  iFormat,
[out, retval] long *  result
) 
 

Create a flat file object from a signature object.

Flags can be specified by environment variable SIGNWARE_ISO_SAVE. Its value is either a decimal number or a hexadecimal number (prefixed by "0x"). The number will be shifted left 20 bits and bitwise or-ed into iFormat, that is, the following values (and combinations thereof) are defined:

Parameters:
pSignature [i] pointer to an instance of ISPSignature
iFormat [i] Format to be used: either one of the following constants: or a combination (bitwise or) of up to one constant from each of the following three groups: No flags can be specified in iFormat, but see CreateFromSignature3.
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:
CreateFromSignature, CreateFromSignature3, SPFlatFileCreateFromSignature2

HRESULT ACTIVESWLib::ISPFlatFile::CreateFromSignature3 (  [in] ISPSignature *  pSignature,
[in] long  iFormat,
[out, retval] long *  result
) 
 

Create a flat file object from a signature object.

This function does not use environment variable SIGNWARE_ISO_SAVE.

Parameters:
pSignature [i] pointer to an instance of ISPSignature
iFormat [i] Format to be used: either one of the following constants: or a combination (bitwise or) of up to one constant from each of the following three groups: For some formats, you can additionally include (bitwise or) these flags:
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:
CreateFromSignature, CreateFromSignature3, SPFlatFileCreateFromSignature3
Since:
Version 3.2.9.1

HRESULT ACTIVESWLib::ISPFlatFile::CreateFromTemplate (  [in] ISPTemplate *  pTemplate,
[out, retval] long *  result
) 
 

Create a flat file from a valid template object.

Parameters:
pTemplate [i] pointer to an instance of ISPTemplate
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:
SPFlatFileCreateFromTemplate

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

Create a flat file from a valid ticket object.

Parameters:
pTicket [i] pointer to an instance of ISPTicket
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:
SPFlatFileCreateFromTicket

HRESULT ACTIVESWLib::ISPFlatFile::GetBase64RawData (  [out] BSTR *  pbstrRawData,
[out, retval] long *  result
) 
 

Create a flat file from a base64 encoded string.

Parameters:
pbstrRawData [o] pointer to a string that will be filled with the Base64 encoded raw data
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:
CreateFromBase64RawData, GetRawData
Note:
This function extends GetRawData but safes the resulting SAFEARRAY as a base64 encoded string.

HRESULT ACTIVESWLib::ISPFlatFile::GetRawData (  [out] SAFEARRAY(BYTE)*  pszRawData,
[out, retval] long *  result
) 
 

Extract the wrapped data.

Parameters:
pszRawData : [o] pointer to the array to be filled (might 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

HRESULT ACTIVESWLib::ISPFlatFile::IsCleanParameter (  [out, retval] long *  result  ) 
 

check if a flat file structure contains a serialized CleanParameter

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
  • 0: the flat file does not contain a serialized CleanParameter
  • 1: the flat file contains a serialized CleanParameter
Returns:
automation result

HRESULT ACTIVESWLib::ISPFlatFile::IsPropertyMap (  [out, retval] long *  result  ) 
 

check if a flat file structure contains a serialized PropertyMap

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
  • 0: the flat file does not contain a serialized PropertyMap
  • 1: the flat file contains a serialized PropertyMap
Returns:
automation result

HRESULT ACTIVESWLib::ISPFlatFile::IsReference (  [out, retval] long *  result  ) 
 

check if a flat file structure contains a serialized reference

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
  • 0: the flat file does not contain a serialized reference structure
  • 1: the flat file contains a serialized reference structure
Returns:
automation result

HRESULT ACTIVESWLib::ISPFlatFile::IsSignature (  [out, retval] long *  result  ) 
 

check if a flat file structure contains a serialized signature

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
  • 0: the flat file does not contain a serialized signature structure
  • 1: the flat file contains a serialized signature structure
Returns:
automation result

HRESULT ACTIVESWLib::ISPFlatFile::IsTemplate (  [out, retval] long *  result  ) 
 

check if a flat file structure contains a serialized template

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
  • 0: the flat file does not contain a serialized template structure
  • 1: the flat file contains a serialized template structure
Returns:
automation result

HRESULT ACTIVESWLib::ISPFlatFile::IsTicket (  [out, retval] long *  result  ) 
 

check if a flat file structure contains a serialized ticket

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
  • 0: the flat file does not contain a serialized ticket structure
  • 1: the flat file contains a serialized ticket structure
Returns:
automation result

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