SPReference Class Reference

List of all members.

---

Detailed Description

PHP Wrapper around the COM object ActiveSW.SPReference.

Note:

the class SPReference requires a prior instance of a SPSignWare object

See also:

ACTIVESWLib.ISPReference

Public Member Functions
	Check ($spPropertyMap=0)
	Check the quality and variance of a reference.
	checkQuality ()
	Check the quality of a reference.
	createFromFlatFile ($aFlatFile)
	Create a SignWare reference from a FlatFile.
	getImage ($iIndex, $dZoom=1.0)
	Query a signature image.
	getImageSize ($iIndex, &$iWidth, &$iHeight)
	Query the size of a signature image (if the zoom would be 1.0).
	getNumberSignatures ()
	Query how many signatures are included in this reference object.
	loadFromFile ($aFileName)
	load this reference object from a file
	saveInFile ($aFileName)
	save the reference object as a file
	setPluginSignature ($strSignature)
	Create a SignWare reference from a captured signature.
	SPReference ()
	Constructor.
Public Attributes
	$className = "SPReference"
	Name of this class.
	$com = false
	native COM handle

---

Constructor & Destructor Documentation

SPReference.SPReference (   )

Constructor. Exceptions: Exception  on errors

---

Member Function Documentation

SPReference.Check (  $  spPropertyMap = 0  )

Check the quality and variance of a reference. The function uses SignWare defaults to check quality and variance if the parameter spPropertyMap is 0 or omitted Parameters: spPropertyMap  [i] SPPropertyMap to set thresholds, may be 0 Returns: TRUE reference quality and variance are OK, else FALSE Exceptions: Exception  on errors Note: This SPReference object must contain valid signatures, e. g. call setPluginSignature to fill this object

SPReference.checkQuality (   )

Check the quality of a reference. Returns: TRUE reference quality is OK, else FALSE Exceptions: Exception  on errors Note: This SPReference object must contain valid signatures, e. g. call setPluginSignature to fill this object

SPReference.createFromFlatFile (  $  aFlatFile  )

Create a SignWare reference from a FlatFile. Parameters: $aFlatFile  [i] the flatfile data Exceptions: Exception  on errors See also: ACTIVESWLib.ISPReference.CreateFromFlatFile

SPReference.getImage (  $  iIndex, $  dZoom = 1.0 )

Query a signature image. Parameters: $iIndex  [i] 0-based index to address a signature object within the reference $dZoom  [i] zoom factor Returns: String the image data [gif format] Exceptions: Exception  on errors Note: This SPReference object must contain valid signatures, e. g. call setPluginSignature to fill this object See also: ACTIVESWLib.ISPReference.GetImage

SPReference.getImageSize (  $  iIndex, &$  iWidth, &$  iHeight )

Query the size of a signature image (if the zoom would be 1.0). Parameters: $iIndex  [i] 0-based index to address a signature object within the reference $iWidth  [o] will be filled with the width of the image [pix] $iHeight  [o] will be filled with the height of the image [pix] Exceptions: Exception  on errors Note: This SPReference object must contain valid signatures, e. g. call setPluginSignature to fill this object See also: ACTIVESWLib.ISPReference.GetImageSize

SPReference.getNumberSignatures (   )

Query how many signatures are included in this reference object. Returns: int the number of signatures Exceptions: Exception  on errors Note: This SPReference object must contain valid signatures, e. g. call setPluginSignature to fill this object See also: ACTIVESWLib.ISPReference.GetSignatureCount

SPReference.loadFromFile (  $  aFileName  )

load this reference object from a file Parameters: $aFileName  [i] name of the file to load the reference Exceptions: Exception  on errors

SPReference.saveInFile (  $  aFileName  )

save the reference object as a file Parameters: $aFileName  [i] name of the file to save the reference Exceptions: Exception  on errors

SPReference.setPluginSignature (  $  strSignature  )

Create a SignWare reference from a captured signature. Parameters: $strSignature  [i] the captured signature data as passed from the signature capture plugin Exceptions: Exception  on errors See also: ACTIVESWLib.ISPReference.CreateFromFlatFile

---

Member Data Documentation

SPReference.$className = "SPReference"

Name of this class.

SPReference.$com = false

native COM handle

---

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

• signware_xapi.php