ACTIVESWLib::ISPCleanParameter Interface Reference

---

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPCleanParameterInterface ISPCleanParameter.

Representation of static cleaning parameters

Public Member Functions
HRESULT	AddEnableFlag ([in] BSTR bstrName,[out, retval] long *result)
	Add an enable flag to the end of the list.
HRESULT	AppendEnableFlag ([in] BSTR bstrName,[out, retval] long *result)
	Add an enable flag to the end of the list.
HRESULT	ClearEnableFlags ([out, retval] long *result)
	Clear all enable flags in the list.
HRESULT	Clone ([out] ISPCleanParameter **ppClone,[out, retval] long *result)
	Copy a CleanParameter object.
HRESULT	Create ([out, retval] long *result)
	Create a clean parameter object.
HRESULT	CreateFromFlatFile ([in] ISPFlatFile *pFlatFile,[out, retval] long *result)
	Create a CleanParameter object from serialized data.
HRESULT	GetDouble ([in] BSTR bstrName,[out] double *paValue,[out, retval] long *result)
	Query the content of a property.
HRESULT	GetEnableFlag ([in] long iIndex,[out] BSTR *pbstrValue,[out, retval] long *result)
	Query the enable flag at index iIndex.
HRESULT	GetEnableFlagCount ([out] long *plCount,[out, retval] long *result)
	Query the count of enable flags.
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 ISPCleanParameter object from a buffer.
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 SPCleanParameter object into a buffer.

---

Member Function Documentation

HRESULT ACTIVESWLib::ISPCleanParameter::AddEnableFlag (  [in] BSTR  bstrName, [out, retval] long *  result )

Add an enable flag to the end of the list. Parameters: bstrName  [i] name of the enable flag that should be added to the list result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_NOERR successfull completion SPX_PARAMERR illegal parameter, iIndex out of bounds Returns: automation result See also: ISPImage::Clean, SPCleanParameterAddEnableFlag

HRESULT ACTIVESWLib::ISPCleanParameter::AppendEnableFlag (  [in] BSTR  bstrName, [out, retval] long *  result )

Add an enable flag to the end of the list. Parameters: bstrName  [i] name of the enable flag that should be added to the list result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_NOERR successfull completion SPX_PARAMERR illegal parameter, iIndex out of bounds Returns: automation result See also: SPCleanParameterAddEnableFlag

HRESULT ACTIVESWLib::ISPCleanParameter::ClearEnableFlags (  [out, retval] long *  result  )

Clear all enable flags in the list. Parameters: result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_NOERR successfull completion SPX_PARAMERR illegal parameter, iIndex out of bounds Returns: automation result See also: SPCleanParameterClearEnableFlags

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

Copy a CleanParameter object. Parameters: ppClone  [o] a pointer to a ISPCleanParameter object that will be filled with the newly created cleaning parameter object. The created cleaning parameter 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_NOERR successfull completion SPX_MEMERR out of memory Returns: automation result Note: The newly created object will be a true copy of the copy object See also: SPCleanParameterClone

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

Create a clean parameter object. Parameters: result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_NOERR successfull completion SPX_MEMERR out of memory SPX_LICENSEERR license error Returns: automation result See also: SPCleanParameterCreate

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

Create a CleanParameter object from serialized data. Parameters: pFlatFile  [i] pointer to the serialized CleanParameter 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_NOERR successfull completion SPX_MEMERR out of memory Returns: automation result Note: This function is similar to Read See also: SPCleanParameterCreateFromFlatFile, ISPFlatFile::CreateFromCleanParamater

HRESULT ACTIVESWLib::ISPCleanParameter::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_NOERR successfull completion SPX_PARAMERR undefined property, or not a double and not an integer Returns: automation result See also: SPCleanParameterGetDouble, SetDouble

HRESULT ACTIVESWLib::ISPCleanParameter::GetEnableFlag (  [in] long  iIndex, [out] BSTR *  pbstrValue, [out, retval] long *  result )

Query the enable flag at index iIndex. Parameters: iIndex  [i] 0-based index pbstrValue  [o] pointer to a string that will be filled with the name of the enable flag at index iIndex result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_NOERR successfull completion SPX_PARAMERR illegal parameter, iIndex out of bounds Returns: automation result See also: SPCleanParameterGetEnableFlag

HRESULT ACTIVESWLib::ISPCleanParameter::GetEnableFlagCount (  [out] long *  plCount, [out, retval] long *  result )

Query the count of enable flags. Parameters: plCount  [0] pointer to a long that will be filled with the count of enable flags result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_NOERR successfull completion SPX_PARAMERR illegal parameter, iIndex out of bounds Returns: automation result See also: ISPImage::Clean, SPCleanParameterGetEnableFlagCount

HRESULT ACTIVESWLib::ISPCleanParameter::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_NOERR successfull completion SPX_PARAMERR undefined property, or not an integer Returns: automation result See also: SPCleanParameterGetInt, SetInt

HRESULT ACTIVESWLib::ISPCleanParameter::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. Use SPFreeString to free the allocated memory. result  [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK errors: SPX_NOERR successfull completion SPX_PARAMERR undefined property Returns: automation result See also: SPCleanParameterGetString, SetString

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

Deserialize a ISPCleanParameter 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_NOERR successfull completion 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 See also: SPCleanParameterRead

HRESULT ACTIVESWLib::ISPCleanParameter::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_NOERR successfull completion SPX_PARAMERR undefined property Returns: automation result See also: SPCleanParameterSetDouble, GetDouble

HRESULT ACTIVESWLib::ISPCleanParameter::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_NOERR successfull completion SPX_PARAMERR undefined property Returns: automation result See also: SPCleanParameterSetInt, GetInt

HRESULT ACTIVESWLib::ISPCleanParameter::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_NOERR successfull completion SPX_PARAMERR undefined property Returns: automation result See also: SPCleanParameterSetString, GetString

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

Serialize a SPCleanParameter 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_NOERR successfull completion SPX_PARAMERR wrong parameter submitted SPX_MEMERR out of memory Returns: automation result See also: SPCleanParameterWrite

---

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

• ActiveSW.idl