visit Kofax web site
ACTIVESWLib::ISPPropertyMap

ACTIVESWLib::ISPPropertyMap Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPPropertyMapInterface ISPPropertyMap.

Representation of a property container


Public Member Functions

HRESULT Clone ([out] ISPPropertyMap **ppClone,[out, retval] long *result)
 Copy a PropertyMap object.
HRESULT Create ([out, retval] long *result)
 Create a PropertyMap object.
HRESULT CreateFromFlatFile ([in] ISPFlatFile *pFlatFile,[out, retval] long *result)
 Create a PropertyMap object from serialized data.
HRESULT Equals ([in] ISPPropertyMap *pObj,[out] long *pEqual,[out, retval] long *result)
 Compare two property maps.
HRESULT GetBool ([in] BSTR bstrName,[out] long *paValue,[out, retval] long *result)
 Query the content of a property.
HRESULT GetData ([in] BSTR bstrName,[out] SAFEARRAY(BYTE)*pData,[out, retval] long *result)
 Query the data content of a property.
HRESULT GetDouble ([in] BSTR bstrName,[out] double *paValue,[out, retval] long *result)
 Query the content of a property.
HRESULT GetInt ([in] BSTR bstrName,[out] long *paValue,[out, retval] long *result)
 Query the content of a property.
HRESULT GetString ([in] BSTR bstrName,[out] BSTR *pbstrValue,[out, retval] long *result)
 Query the string content of a property.
HRESULT Read ([in] SAFEARRAY(BYTE)*pData,[out, retval] long *result)
 Deserialize a ISPPropertyMap object from a buffer.
HRESULT SetBool ([in] BSTR bstrName,[in] long aValue,[out, retval] long *result)
 Set the value of a property.
HRESULT SetData ([in] BSTR bstrName,[in] SAFEARRAY(BYTE)*pData,[out, retval] long *result)
 Set the data content of a property.
HRESULT SetDouble ([in] BSTR bstrName,[in] double aValue,[out, retval] long *result)
 Set the value of a property.
HRESULT SetInt ([in] BSTR bstrName,[in] long aValue,[out, retval] long *result)
 Set the value of a property.
HRESULT SetString ([in] BSTR bstrName,[in] BSTR bstrValue,[out, retval] long *result)
 Set the string content of a property.
HRESULT Write ([out] SAFEARRAY(BYTE)*pData,[out, retval] long *result)
 Serialize a SPPropertyMap object into a buffer.

Member Function Documentation

HRESULT ACTIVESWLib::ISPPropertyMap::Clone (  [out] ISPPropertyMap **  ppClone,
[out, retval] long *  result
) 
 

Copy a PropertyMap object.

Parameters:
ppClone [o] a pointer to a ISPPropertyMap object that will be filled with the newly created property map object. The created property map object will be preset to the same values as this object.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_MEMERR out of memory
Returns:
automation result
Note:
The newly created object will be a true copy of the copy object

HRESULT ACTIVESWLib::ISPPropertyMap::Create (  [out, retval] long *  result  ) 
 

Create a PropertyMap object.

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_MEMERR out of memory
Returns:
automation result

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

Create a PropertyMap object from serialized data.

Parameters:
pFlatFile [i] pointer to the serialized PropertyMap data in a ISPFlatFile object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_MEMERR out of memory
Returns:
automation result
Note:
This function is similar to Read

HRESULT ACTIVESWLib::ISPPropertyMap::Equals (  [in] ISPPropertyMap *  pObj,
[out] long *  pEqual,
[out, retval] long *  result
) 
 

Compare two property maps.

Parameters:
pObj [i] a propertymap
pEqual [o] pointer to an integer that will be set to 0 if the maps are not equal
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_PARAMERR undefined property, or not an integer
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::GetBool (  [in] BSTR  bstrName,
[out] long *  paValue,
[out, retval] long *  result
) 
 

Query the content of a property.

Parameters:
bstrName [i] the name of the property
paValue [o] pointer to an integer that will be filled with the contents of the property.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_PARAMERR undefined property, or not an integer
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::GetData (  [in] BSTR  bstrName,
[out] SAFEARRAY(BYTE)*  pData,
[out, retval] long *  result
) 
 

Query the data content of a property.

Parameters:
bstrName [i] the name of the property
pData [o] pointer to a safe array that will be filled with the contents of the property. Memory will be allocated as required.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_PARAMERR undefined property
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::GetDouble (  [in] BSTR  bstrName,
[out] double *  paValue,
[out, retval] long *  result
) 
 

Query the content of a property.

Parameters:
bstrName [i] the name of the property
paValue [o] pointer to a double that will be filled with the contents of the property.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_PARAMERR undefined property, or not a double and not an integer
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::GetInt (  [in] BSTR  bstrName,
[out] long *  paValue,
[out, retval] long *  result
) 
 

Query the content of a property.

Parameters:
bstrName [i] the name of the property
paValue [o] pointer to an integer that will be filled with the contents of the property.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_PARAMERR undefined property, or not an integer
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::GetString (  [in] BSTR  bstrName,
[out] BSTR *  pbstrValue,
[out, retval] long *  result
) 
 

Query the string content of a property.

Parameters:
bstrName [i] the name of the property
pbstrValue [o] pointer to a char pointer that will be filled with the contents of the property. Memory will be allocated as required.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_PARAMERR undefined property
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::Read (  [in] SAFEARRAY(BYTE)*  pData,
[out, retval] long *  result
) 
 

Deserialize a ISPPropertyMap object from a buffer.

Parameters:
pData [i] a SAFEARRAY that contains the serialized data
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_PARAMERR wrong parameter submitted
  • SPX_MEMERR out of memory
  • SPX_VERSIONERR wrong flat file version (or corrupted data)
  • SPX_CORRUPTEDDATAERR corrupted data, not enough data
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::SetBool (  [in] BSTR  bstrName,
[in] long  aValue,
[out, retval] long *  result
) 
 

Set the value of a property.

Parameters:
bstrName [i] the name of the property
aValue [i] the value of the property
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_MEMERR out of memory
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::SetData (  [in] BSTR  bstrName,
[in] SAFEARRAY(BYTE)*  pData,
[out, retval] long *  result
) 
 

Set the data content of a property.

Parameters:
bstrName [i] the name of the property
pData [i] pointer to the data that should be passed to the property
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_MEMERR out of memory
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::SetDouble (  [in] BSTR  bstrName,
[in] double  aValue,
[out, retval] long *  result
) 
 

Set the value of a property.

Parameters:
bstrName [i] the name of the property
aValue [i] the value of the property
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_MEMERR out of memory
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::SetInt (  [in] BSTR  bstrName,
[in] long  aValue,
[out, retval] long *  result
) 
 

Set the value of a property.

Parameters:
bstrName [i] the name of the property
aValue [i] the value of the property
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_MEMERR out of memory
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::SetString (  [in] BSTR  bstrName,
[in] BSTR  bstrValue,
[out, retval] long *  result
) 
 

Set the string content of a property.

Parameters:
bstrName [i] the name of the property
bstrValue [i] pointer to the string that should be passed to the property
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_MEMERR out of memory
Returns:
automation result

HRESULT ACTIVESWLib::ISPPropertyMap::Write (  [out] SAFEARRAY(BYTE)*  pData,
[out, retval] long *  result
) 
 

Serialize a SPPropertyMap object into a buffer.

Parameters:
pData [o] a pointer to a SAFEARRAY that will be filled with the serialized data
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SPX_PARAMERR wrong parameter submitted
  • SPX_MEMERR out of memory
Returns:
automation result

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