visit Kofax web site
ACTIVESWLib::ISPSignature

ACTIVESWLib::ISPSignature Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPSignatureInterface ISPSignature.

Signature container.


Public Member Functions

HRESULT AddVector ([in] long iX,[in] long iY,[in] long iPress,[out, retval] long *result)
 Add a tablet vector to a valid signature structure.
HRESULT AddVector2 ([in] long iX,[in] long iY,[in] long iPress,[in] long iTime,[out, retval] long *result)
 Add a tablet vector to a valid signature structure.
HRESULT Check ([in] ISPPropertyMap *pParams,[out, retval] long *result)
 Check a signature.
HRESULT ClearVectors ([out, retval] long *result)
 Clear the contents of the signature.
HRESULT Clone ([out] ISPSignature **ppSignature,[out, retval] long *result)
 Clone a signature structure.
HRESULT Create ([out, retval] long *result)
 Create an empty signature.
HRESULT CreateFromAcquire ([in] ISPAcquire *pSPAcquire,[out, retval] long *result)
 get the current signature data structure during acquiry
HRESULT CreateFromBioData ([in] ISPFlatFile *pBioData,[out, retval] long *result)
 Get the signature of a biodata object.
HRESULT CreateFromFlatFile ([in] ISPFlatFile *pFlatFile,[out, retval] long *result)
 Load a signature from a flat file object.
HRESULT CreateFromFlatFile3 ([in] ISPFlatFile *pFlatFile,[in] long iFlags,[out, retval] long *result)
 Load a signature from a flat file object.
HRESULT CreateFromGuiAcqu ([in] ISPGuiAcqu *pSPGui,[out, retval] long *result)
 get the current signature data structure during acquiry
HRESULT CreateFromGuiDisp ([in] ISPGuiDisp *pSPGui,[out, retval] long *result)
 get the signature associated with the SPGuiDisp object
HRESULT CreateFromGuiDyn ([in] ISPGuiDyn *pSPGui,[out, retval] long *result)
 get the signature associated with the SPGuiDyn object
HRESULT CreateFromReference ([in] ISPReference *pReference,[in] long iIndex,[out, retval] long *result)
 Create a new signature structure and initialize all device specific fields with values from a refrence structure.
HRESULT CreateFromTablet ([in] ISPTablet *pTablet,[out, retval] long *result)
 Create a new signature structure and initialize all device specific fields with values from the selected tablet.
HRESULT CreateFromTellerImage ([in] ISPTellerImage *pTellerImage,[out, retval] long *result)
 Get the signature of a teller image.
HRESULT CreateFromTemplate ([in] ISPTemplate *pTemplate,[out, retval] long *result)
 Get the signature of a template.
HRESULT GetComplexity ([out] long *plComplexity,[out, retval] long *result)
 Get the complexity of the signature in this object.
HRESULT GetDevice ([out] long *piDevice,[out, retval] long *result)
 Query the device from a signature.
HRESULT GetImage ([in] double dZoom,[in] long iImageFormat,[out] ISPFlatFile **ppImage,[out, retval] long *result)
 Convert a signature to a standard image file format.
HRESULT GetImageSize ([out] long *piWidth,[out] long *piHeight,[out, retval] long *result)
 Query the image size of this signature object.
HRESULT GetMaxPressure ([out] long *piMaxPressure,[out, retval] long *result)
 Query the pressure range from a signature.
HRESULT GetNrVectors ([out] long *piNrVectors,[out, retval] long *result)
 Query the number of tablet vectors included in the signature.
HRESULT GetPadSerial ([out] SAFEARRAY(BYTE)*psaPadSerial,[out, retval] long *result)
 Query the tablet serial identification.
HRESULT GetResolution ([out] long *piResolution,[out, retval] long *result)
 Query the resolution from a signature.
HRESULT GetSampleRate ([out] long *piSampleRate,[out, retval] long *result)
 Query the Sample Rate from a signature.
HRESULT GetTimeStamp ([out] long *piTimeStamp,[out, retval] long *result)
 Query the timestamp from a signature.
HRESULT GetVector ([in] long iIndex,[out] long *piX,[out] long *piY,[out] long *piPress,[out, retval] long *result)
 Query the values of a vector included in the signature.
HRESULT GetVector2 ([in] long iIndex,[out] long *piX,[out] long *piY,[out] long *piPress,[out] long *piTime,[out, retval] long *result)
 Query the values of a vector included in the signature.
HRESULT MirrorY ([out, retval] long *result)
 Mirror a signature vertically.
HRESULT SetDevice ([in] long lDevice,[out, retval] long *result)
 Set the device in a signature object.
HRESULT SetMaxPressure ([in] long lMaxPressure,[out, retval] long *result)
 Set the max pressure in a signature object.
HRESULT SetPadSerial ([in] SAFEARRAY(BYTE)*psaPadSerial,[out, retval] long *result)
 Query the tablet serial identification.
HRESULT SetResolution ([in] long lResolution,[out, retval] long *result)
 Set the resolution in a signature object.
HRESULT SetSampleRate ([in] long iSampleRate,[out, retval] long *result)
 Set (Overwrite) the Sample Rate of a signature.
HRESULT SetStaticGrayAlias ([in] long lGrayAlias,[out, retval] long *result)
 Calculate gray levels in a static signature either from pressure levels of the vectors or from aliasing.
HRESULT SetStaticPenWidth ([in] double dPenWidth,[out, retval] long *result)
 Set the pen width for rendering the signature as a static image, default 0.5 mm.
HRESULT SetTicket ([in] ISPTicket *pTicket,[out, retval] long *result)
 Set the ticket for rendering the signature.
HRESULT SetTimeStamp ([in] long iTimeStamp,[out, retval] long *result)
 Set (Overwrite) the timestamp of a signature.

Data Fields

const BSTR SPX_SIGNATURE_MIN_HEIGHT = L"SPSignatureMinHeight"
 Min signature height.
const BSTR SPX_SIGNATURE_MIN_PRESSURE_LEVELS = L"SPSignatureMinPressureLevels"
 Min signature pressure levels.
const BSTR SPX_SIGNATURE_MIN_STATIC_QUALITY = L"SPSignatureMinStaticQuality"
 Min static signature quality.
const BSTR SPX_SIGNATURE_MIN_VECTORS = L"SPSignatureMinVectors"
 Min signature vectors (with pressure greater than 0).
const BSTR SPX_SIGNATURE_MIN_WIDTH = L"SPSignatureMinWidth"
 Min signature width.

Member Function Documentation

HRESULT ACTIVESWLib::ISPSignature::AddVector (  [in] long  iX,
[in] long  iY,
[in] long  iPress,
[out, retval] long *  result
) 
 

Add a tablet vector to a valid signature structure.

Parameters:
iX [i] X-Component of the vector [in tablet coordinates]
iY [i] Y-Component of the vector [in tablet coordinates]
iPress [i] pressure of the vector
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::AddVector2 (  [in] long  iX,
[in] long  iY,
[in] long  iPress,
[in] long  iTime,
[out, retval] long *  result
) 
 

Add a tablet vector to a valid signature structure.

Parameters:
iX [i] X-Component of the vector [in tablet coordinates]
iY [i] Y-Component of the vector [in tablet coordinates]
iPress [i] pressure of the vector
iTime [i] time of this vector since signature capture start in milliseconds, -1 if not supported
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::Check (  [in] ISPPropertyMap *  pParams,
[out, retval] long *  result
) 
 

Check a signature.

Signature plausability check. A signature should exceed a certain size and contain a pressure level range.

Parameters:
pParams [i] Parameters, may be NULL
result [io] Signware result
Returns:
Automation result, S_OK on success, else error code
See also:
SPSignatureCheck

HRESULT ACTIVESWLib::ISPSignature::ClearVectors (  [out, retval] long *  result  ) 
 

Clear the contents of the signature.

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
Automation result
Note:
All signature vectors will be removed from this signature object

HRESULT ACTIVESWLib::ISPSignature::Clone (  [out] ISPSignature **  ppSignature,
[out, retval] long *  result
) 
 

Clone a signature structure.

Parameters:
ppSignature [o] pointer to a pSPSIGNATURE_T variable, that will be filled with a valid pSPSIGNATURE_T data structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureCreate

SPSignatureFree

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

Create an empty signature.

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::CreateFromAcquire (  [in] ISPAcquire *  pSPAcquire,
[out, retval] long *  result
) 
 

get the current signature data structure during acquiry

Parameters:
pSPAcquire [i] a pointer to a valid SPACQUIRE_T data structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
Note:
It is the applications responsabilty to free the returned signature. You cannot change any fields in the acquired signature, because the returned signature object is a copy the acquired signature.
See also:
SPSignatureFree

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

Get the signature of a biodata object.

Parameters:
pBioData [i] pointer to a valid biodata object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

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

Load a signature from a flat file object.

This function deserializes an SPSignature object serialized by ISPFlatFile::CreateFromSignature.

CreateFromFlatFile() is equivalent to CreateFromFlatFile3() with a value of zero for iFlags unless overridden by environment variable SIGNWARE_ISO_LOAD.

The value of that environment variable is either a decimal number or a hexadecimal number (prefixed by "0x"). The number will be shifted left 20 bits, that is, the following values (and combinations thereof) are defined:

Parameters:
pFlatFile [i] pointer to a valid FlatFile object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
CreateFromFlatFile2

HRESULT ACTIVESWLib::ISPSignature::CreateFromFlatFile3 (  [in] ISPFlatFile *  pFlatFile,
[in] long  iFlags,
[out, retval] long *  result
) 
 

Load a signature from a flat file object.

This function deserializes an SPSignature object serialized by ISPFlatFile::CreateFromSignature.

This function does not use environment variable SIGNWARE_ISO_LOAD.

Parameters:
pFlatFile [i] pointer to a valid FlatFile object
iFlags [i] flags modifying the behavior of this function:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
CreateFromFlatFile

HRESULT ACTIVESWLib::ISPSignature::CreateFromGuiAcqu (  [in] ISPGuiAcqu *  pSPGui,
[out, retval] long *  result
) 
 

get the current signature data structure during acquiry

Parameters:
pSPGui [i] a pointer to a valid SPGUIACQU_T data structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
Note:
It is the applications responsabilty to free the returned signature. You cannot change any fields in the acquired signature, because the returned signature object is a copy the acquired signature.
See also:
SPSignatureFree

HRESULT ACTIVESWLib::ISPSignature::CreateFromGuiDisp (  [in] ISPGuiDisp *  pSPGui,
[out, retval] long *  result
) 
 

get the signature associated with the SPGuiDisp object

Parameters:
pSPGui [i] a pointer to a valid SPGUIDISP_T data structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPGuiDispCreate, SPGuiDispFree, SPGuiSetSignature

HRESULT ACTIVESWLib::ISPSignature::CreateFromGuiDyn (  [in] ISPGuiDyn *  pSPGui,
[out, retval] long *  result
) 
 

get the signature associated with the SPGuiDyn object

Parameters:
pSPGui [i] a pointer to a valid ISPGuiDyn object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPGuiDynSetSignature

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

Create a new signature structure and initialize all device specific fields with values from a refrence structure.

Parameters:
pReference [i] pointer to reference structure
iIndex [i] signature index within the reference
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureCreate, SPSignatureCreateFromTablet

SPSignatureFree

HRESULT ACTIVESWLib::ISPSignature::CreateFromTablet (  [in] ISPTablet *  pTablet,
[out, retval] long *  result
) 
 

Create a new signature structure and initialize all device specific fields with values from the selected tablet.

Parameters:
pTablet [i] pointer to a pSPTABLET_T structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureCreate, SPSignatureCreateFromReference

SPSignatureFree

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

Get the signature of a teller image.

Parameters:
pTellerImage [i] pointer to a valid ISPTellerImage object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

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

Get the signature of a template.

Parameters:
pTemplate [i] pointer to a valid Template object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::GetComplexity (  [out] long *  plComplexity,
[out, retval] long *  result
) 
 

Get the complexity of the signature in this object.

Parameters:
plComplexity [o] Pointer to a long that will be filled with the complexity of the signature.
The complexity has a range from 0 ... 100, 0 equals the most simple signature
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureGetComplexity
Note:
You should not overwrite the device unless you konow ehat you are doing!
Since:
Version 3.2.2

HRESULT ACTIVESWLib::ISPSignature::GetDevice (  [out] long *  piDevice,
[out, retval] long *  result
) 
 

Query the device from a signature.

Parameters:
piDevice [o] pointer to an SPINT32 that will be filled with the device tag from pSignature
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::GetImage (  [in] double  dZoom,
[in] long  iImageFormat,
[out] ISPFlatFile **  ppImage,
[out, retval] long *  result
) 
 

Convert a signature to a standard image file format.

Note:
The created image is a BW or gray image. Please use SPImage.setSignature and SPImage.setBitsPerPixel to convert the image to a color image if you prefer a color image.
Parameters:
dZoom [i] magnification value of the resulting image
iImageFormat [i] desired format of the resulting image
  • SPX_IMAGE_GIF
  • SPX_IMAGE_CCITT4
  • SPX_IMAGE_TIFF
  • SPX_IMAGE_BMP_WIN
  • further options include SPX_IMAGE_BLACKWHITE, SPX_IMAGE_BLACKWHITE_1BPP and SPX_IMAGE_CROSSED
ppImage [o] pointer to a variable that will be filled with the address of the data buffer
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureGetImage, SetStaticPenWidth, SetStaticGrayAlias, SPImageTypes

HRESULT ACTIVESWLib::ISPSignature::GetImageSize (  [out] long *  piWidth,
[out] long *  piHeight,
[out, retval] long *  result
) 
 

Query the image size of this signature object.

Parameters:
piWidth [o] pointer to an integer that will be filled with the width of the image
piHeight [o] pointer to an integer that will be filled with the height of the image
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureGetImage

HRESULT ACTIVESWLib::ISPSignature::GetMaxPressure (  [out] long *  piMaxPressure,
[out, retval] long *  result
) 
 

Query the pressure range from a signature.

Parameters:
piMaxPressure [o] pointer to an SPINT32 that will be filled with the max pressure tag from pSignature
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::GetNrVectors (  [out] long *  piNrVectors,
[out, retval] long *  result
) 
 

Query the number of tablet vectors included in the signature.

Parameters:
piNrVectors [o] pointer to an SPINT32 that will be filled with the number of tablet vectors in pSignature
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::GetPadSerial (  [out] SAFEARRAY(BYTE)*  psaPadSerial,
[out, retval] long *  result
) 
 

Query the tablet serial identification.

Parameters:
psaPadSerial [o] pointer to a safe array that will be filled with the tablet serial identification
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureGetPadSerial

HRESULT ACTIVESWLib::ISPSignature::GetResolution (  [out] long *  piResolution,
[out, retval] long *  result
) 
 

Query the resolution from a signature.

Parameters:
piResolution [o] pointer to an SPINT32 that will be filled with the resolution tag from pSignature
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::GetSampleRate (  [out] long *  piSampleRate,
[out, retval] long *  result
) 
 

Query the Sample Rate from a signature.

Parameters:
piSampleRate [o] pointer to an SPINT32 that will be filled with the sample rate tag from pSignature
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::GetTimeStamp (  [out] long *  piTimeStamp,
[out, retval] long *  result
) 
 

Query the timestamp from a signature.

Parameters:
piTimeStamp [o] pointer to an SPINT32 that will be filled with the timestamp tag from pSignature
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::GetVector (  [in] long  iIndex,
[out] long *  piX,
[out] long *  piY,
[out] long *  piPress,
[out, retval] long *  result
) 
 

Query the values of a vector included in the signature.

Parameters:
iIndex [i] Index to address the requested tablet vector
piX [o] pointer to an SPINT32 that will be filled with the X-coordinate of the requested vector (in Tablet coordinate space)
piY [o] pointer to an SPINT32 that will be filled with the Y-coordinate of the requested vector (in Tablet coordinate space)
piPress [o] pointer to an SPINT32 that will be filled with the pressure of the requested vector
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::GetVector2 (  [in] long  iIndex,
[out] long *  piX,
[out] long *  piY,
[out] long *  piPress,
[out] long *  piTime,
[out, retval] long *  result
) 
 

Query the values of a vector included in the signature.

Parameters:
iIndex [i] Index to address the requested tablet vector
piX [o] pointer to an SPINT32 that will be filled with the X-coordinate of the requested vector (in Tablet coordinate space)
piY [o] pointer to an SPINT32 that will be filled with the Y-coordinate of the requested vector (in Tablet coordinate space)
piPress [o] pointer to an SPINT32 that will be filled with the pressure of the requested vector
piTime [o] pointer to a long that will be filled with the time of the requested vector in milliseconds since signature capture start, or -1 if not supported
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::MirrorY (  [out, retval] long *  result  ) 
 

Mirror a signature vertically.

The signature is mirrored such that the range of Y coordinates is not changed.

Parameters:
result [io] pointer to a long that will be filled with the SDK result if the functions returns S_OK.
Returns:
0: success, else error code
errors:
Since:
Version 3.2.9.1

HRESULT ACTIVESWLib::ISPSignature::SetDevice (  [in] long  lDevice,
[out, retval] long *  result
) 
 

Set the device in a signature object.

Parameters:
lDevice [i] Device ID
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureSetDevice
Note:
You should not overwrite the device unless you konow ehat you are doing!

HRESULT ACTIVESWLib::ISPSignature::SetMaxPressure (  [in] long  lMaxPressure,
[out, retval] long *  result
) 
 

Set the max pressure in a signature object.

Parameters:
lMaxPressure [i] max pressure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureSetMaxPressure
Note:
You should not overwrite the device unless you konow ehat you are doing!

HRESULT ACTIVESWLib::ISPSignature::SetPadSerial (  [in] SAFEARRAY(BYTE)*  psaPadSerial,
[out, retval] long *  result
) 
 

Query the tablet serial identification.

Parameters:
psaPadSerial [i] pointer to a safe array that contains the tablet serial identification
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:
SPSignatureSetPadSerial

HRESULT ACTIVESWLib::ISPSignature::SetResolution (  [in] long  lResolution,
[out, retval] long *  result
) 
 

Set the resolution in a signature object.

Parameters:
lResolution [i] new Resolution
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureSetResolution
Note:
You should not overwrite the resolution unless you konow ehat you are doing!

HRESULT ACTIVESWLib::ISPSignature::SetSampleRate (  [in] long  iSampleRate,
[out, retval] long *  result
) 
 

Set (Overwrite) the Sample Rate of a signature.

Parameters:
iSampleRate [i] Sample rate of the signature
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPTabletGetSampleRate, SPTabletAcquireDone
Note:
This method is provided to overwrite the sample rate when using WACOM tablets.
Wacom tablets always return a sample rate of 100 Hz, although the true sample rate may differ. The SDK calculates the true sample rate, when calling SPTabletAcquireDone. You should set the sample rate if the calculated sample (call SPTabletGetSampleRate) differs from the default set sample rate.

HRESULT ACTIVESWLib::ISPSignature::SetStaticGrayAlias (  [in] long  lGrayAlias,
[out, retval] long *  result
) 
 

Calculate gray levels in a static signature either from pressure levels of the vectors or from aliasing.

By default, the gray level is based on the pressure level of a vector.

Parameters:
lGrayAlias [i] SPTRUE: calculate the gray level from aliasing, else calculate the gray level from the pressure.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPSignatureSetStaticGrayAlias
Since:
Version 3.0

HRESULT ACTIVESWLib::ISPSignature::SetStaticPenWidth (  [in] double  dPenWidth,
[out, retval] long *  result
) 
 

Set the pen width for rendering the signature as a static image, default 0.5 mm.

Parameters:
dPenWidth [i] pen width in [mm]
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
Automation result

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

Set the ticket for rendering the signature.

Deprecated:
Please use a license key.
Note:
The usage must be SP_TICKET_RENDER
Parameters:
pTicket [i] pointer to a charged ticket object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:

HRESULT ACTIVESWLib::ISPSignature::SetTimeStamp (  [in] long  iTimeStamp,
[out, retval] long *  result
) 
 

Set (Overwrite) the timestamp of a signature.

Parameters:
iTimeStamp [i] timestamp of the signature
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
0: success, else error code
errors:
See also:
SPTabletGetTimeStamp
Note:
This method is provided to add a timestamp to a signature

Field Documentation

const BSTR ACTIVESWLib::ISPSignature::SPX_SIGNATURE_MIN_HEIGHT = L"SPSignatureMinHeight"
 

Min signature height.

See also:
check

const BSTR ACTIVESWLib::ISPSignature::SPX_SIGNATURE_MIN_PRESSURE_LEVELS = L"SPSignatureMinPressureLevels"
 

Min signature pressure levels.

See also:
check

const BSTR ACTIVESWLib::ISPSignature::SPX_SIGNATURE_MIN_STATIC_QUALITY = L"SPSignatureMinStaticQuality"
 

Min static signature quality.

See also:
check

const BSTR ACTIVESWLib::ISPSignature::SPX_SIGNATURE_MIN_VECTORS = L"SPSignatureMinVectors"
 

Min signature vectors (with pressure greater than 0).

See also:
check

const BSTR ACTIVESWLib::ISPSignature::SPX_SIGNATURE_MIN_WIDTH = L"SPSignatureMinWidth"
 

Min signature width.

See also:
check

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