visit Kofax web site
ACTIVESWLib::ISPCompare

ACTIVESWLib::ISPCompare Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPCompareInterface ISPCompare.

Compare signatures and references or templates or static images using the static and / or dynamic and / or statistic comparison engines.

ISPCompare instances save all properties such as match quality or projection factor within the instance object for later usage in the compare functions.
The application will typically select the engines to use (SetMode), set compare parameters (SetMatchQualityEx) and perform the comparison (CompareReference, CompareTemplate, CompareImage, CompareStaticReference, CompareStaticTemplate, CompareStaticImage).
The final result (GetResult) is composed from the result of all engines, the final result will be false (no match) if any of the selected engines calculated a match rate less than the minimum match quality for the engine.
The application may query the detailed results of all selected engines (GetDetailResult, GetNumResults) and implement another match algorithm based on the detail results.

The ISPCompare class uses several engines to compare signatures, a dynamic, a static and a statistic engine. The match quality of all engines is normalized in the range 0 ... 100, where 0 means very low match quality, and 100 means high probability that signature and reference were entered by the same person.
Do not assume that there is a linear relation of match quality and signature similarity.

Please read section sec_Performance and section sec_StaticPerformance

// Example (C#)
public int Compare(SPReference aReference, SPSignature aSignature, int iMode)
{
    SPCompare spCompare = new SPCompare();
    int rc = spCompare.Create();
    if(rc != (int) SPError.SPX_NOERR) return rc;
    if((iMode & (int) SPCompareMode.SPX_COMPARE_DYNAMIC) != 0) {
        int iSampleRateSigno;
        int iSampleRateRef;
        int iPressSigno;
        int iPressRef;
        int iSignos;
        aSignature.GetMaxPressure(out iPressSigno);
        aSignature.GetSampleRate(out iSampleRateSigno);
        SPSignature aSigno = new SPSignature();
        aSigno.CreateFromReference(aReference, 0);
        aSigno.GetMaxPressure(out iPressRef);
        aSigno.GetSampleRate(out iSampleRateRef);
        aRef.GetSignatureCount(out iSignos);
        if(iSampleRateSigno == 0 || iSampleRateRef == 0 || iPressSigno <= 2 || iPressRef <= 2 || iSignos < 2) {
            // Signature or reference do not fulfill requirements for dynamic engine, but can use statistic engine 
            iMode &= ~(int) SPCompareMode.SPX_COMPARE_DYNAMIC;
            iMode |= (int) SPCompareMode.SPX_COMPARE_DSTAT;
        }
    }
    rc = spCompare.setMode(iMode);
    if(rc != (int) SPError.SPX_NOERR) return rc;

    rc = spCompare.CompareReference(aReference, aSignature);
    if(rc != (int) SPError.SPX_NOERR) return rc;

    // Query the final result from the SPCompare object
    int iRes;
    rc = spCompare.GetResult(out iRes);
    if(rc != (int) SPError.SPX_NOERR) return rc;

    // dump detailed results
    GetDetailResult(spCompare, SPCompareEngine.SPX_COMPARE_DYNAMIC_ENGINE, "dynamic");
    GetDetailResult(spCompare, SPCompareEngine.SPX_COMPARE_DSTAT_ENGINE, "statistic");
    GetDetailResult(spCompare, SPCompareEngine.SPX_COMPARE_STATIC_ENGINE, "static");

    return iRes;
} 

private void GetDetailResult(SPCompare spCompare, SPCompareEngine aEngine, String strEngine)
{
    int iNumResults;
    String strRes("");
    spCompare.GetNumResults((int)aEngine, out iNumResults);
    if(iNumResults > 0) {
        for (int ik = 0; ik < iNumResults; ik++)
        {
            int iOutVal;
            spCompare.GetDetailResult((int)aEngine, ik, out iOutVal);
            if (iOutVal < 0)
            {
                // Error
                String errStr;
                SPSignware spSignware = new SPSignware();
                spSignware.GetErrorString(iOutVal, out errStr);
                strRes += strEngine + "[" + ik + "]: " + iOutVal + ", " + errStr + "\n";
            }
            else
            {
                strRes += strEngine + "[" + ik + "]: " + iOutVal + "\n";
            }
        }
        Console.WriteLine(strRes);
    }
}


Public Member Functions

HRESULT CompareImage ([in] ISPImage *pImage,[in] ISPSignature *pSignature,[out, retval] long *result)
 compare a signature with a static image
HRESULT CompareReference ([in] ISPReference *pReference,[in] ISPSignature *pSignature,[out, retval] long *result)
 compare a signature with a reference
HRESULT CompareStaticImage ([in] ISPImage *pImage,[in] ISPImage *pSignature,[out, retval] long *result)
 compare a static signature with a static reference
HRESULT CompareStaticReference ([in] ISPReference *pReference,[in] ISPImage *pSignature,[out, retval] long *result)
 compare a static signature with a reference
HRESULT CompareStaticTemplate ([in] ISPTemplate *pTemplate,[in] ISPImage *pSignature,[out, retval] long *result)
 compare a static signature with a template
HRESULT CompareTemplate ([in] ISPTemplate *pTemplate,[in] ISPSignature *pSignature,[out, retval] long *result)
 compare a signature with a template
HRESULT Create ([out, retval] long *result)
 Create the comppare instance.
HRESULT GetDetailResult ([in] long lEngine,[in] long iIndex,[out] long *piResult,[out, retval] long *result)
 Get the result for the specified engine.
HRESULT GetDynamicMatchQuality ([out] long *piMinDynamicQuality,[out, retval] long *result)
 Get the min. Match rate for dynamic verfication.
HRESULT GetDynamicResult ([out] long *piResult,[out, retval] long *result)
 Get the result of a dynamic comparison.
HRESULT GetMatchQuality ([out] long *piMinDynamicQuality,[out] long *piMinStaticQuality,[out, retval] long *result)
 Get the min. Match rate for static and dynamic verfication.
HRESULT GetMatchQualityEx ([in] long lEngine,[out] long *piMinQuality,[out, retval] long *result)
 Get the min. Match rate for the specified verfication.
HRESULT GetMode ([out] long *piMode,[out, retval] long *result)
 Get the compare mode.
HRESULT GetNumResults ([in] long lEngine,[out] long *piResult,[out, retval] long *result)
 Query the number of available results for the specified engine.
HRESULT GetResult ([out] long *piResult,[out, retval] long *result)
 Get the final result of a comparison.
HRESULT GetStaticMatchQuality ([out] long *piMinStaticQuality,[out, retval] long *result)
 Get the min. Match rate for static verfication.
HRESULT GetStaticResult ([in] long iIndex,[out] long *piResult,[out, retval] long *result)
 Get the result of a static comparison.
HRESULT SetDynamicMatchQuality ([in] long iMinDynamicQuality,[out, retval] long *result)
 Set the min. Match rate for sdynamic verfication.
HRESULT SetMatchQuality ([in] long iMinDynamicQuality,[in] long iMinStaticQuality,[out, retval] long *result)
 Set the min. Match rate for static and dynamic verfication.
HRESULT SetMatchQualityEx ([in] long lEngine,[in] long iMinQuality,[out, retval] long *result)
 Set the min. Match rate for the specified verfication engine.
HRESULT SetMaximumResolution ([in] long iMaximumResolution,[out, retval] long *result)
 Set the maximum Resolution for signature and reference which are passed to the engines.
HRESULT SetMode ([in] long iMode,[out, retval] long *result)
 Set the compare mode.
HRESULT SetStaticMatchQuality ([in] long iMinStaticQuality,[out, retval] long *result)
 Set the min. Match rate for static verfication.
HRESULT SetTicket ([in] ISPTicket *pTicket,[out, retval] long *result)
 Pass charged ticket for a compare operation.

Member Function Documentation

HRESULT ACTIVESWLib::ISPCompare::CompareImage (  [in] ISPImage *  pImage,
[in] ISPSignature *  pSignature,
[out, retval] long *  result
) 
 

compare a signature with a static image

Note:
the final result will alays be 'no match' if the compare modes include SPX_COMPARE_DYNAMIC or SPX_COMPARE_DSTAT
Parameters:
pImage [i] pointer to a valid image structure
pSignature [i] pointer to a valid signature structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
The return code will be 0, although one or more compares were not successful, call SPGetCompareResult for details on the compare result.
See also:
SPCompareImage

HRESULT ACTIVESWLib::ISPCompare::CompareReference (  [in] ISPReference *  pReference,
[in] ISPSignature *  pSignature,
[out, retval] long *  result
) 
 

compare a signature with a reference

Note:
the final result will alays be 'no match' if the compare modes include SPX_COMPARE_DYNAMIC and reference or signature were capture with a device that has 2 pressure levels, or has no constant sample rate, or the reference contains one signature.
Parameters:
pReference [i] pointer to a valid reference structure
pSignature [i] pointer to a valid signature structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
The return code will be 0, although one or more compares were not successful, call SPGetCompareResult for details on the compare result.
See also:
SPCompareReference, SPX_COMPARE_STATIC, SPX_COMPARE_DYNAMIC, SPX_COMPARE_DESKEW, SetMode

HRESULT ACTIVESWLib::ISPCompare::CompareStaticImage (  [in] ISPImage *  pImage,
[in] ISPImage *  pSignature,
[out, retval] long *  result
) 
 

compare a static signature with a static reference

Note:
the final result will alays be 'no match' if the compare modes include SPX_COMPARE_DYNAMIC or SPX_COMPARE_DSTAT
Parameters:
pImage [i] pointer to a valid image structure
pSignature [i] pointer to a valid image structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
The return code will be 0, although one or more compares were not successful, call SPGetCompareResult for details on the compare result.
See also:
SPCompareStaticImage

HRESULT ACTIVESWLib::ISPCompare::CompareStaticReference (  [in] ISPReference *  pReference,
[in] ISPImage *  pSignature,
[out, retval] long *  result
) 
 

compare a static signature with a reference

Note:
the final result will alays be 'no match' if the compare modes include SPX_COMPARE_DYNAMIC or SPX_COMPARE_DSTAT
Parameters:
pReference [i] pointer to a valid reference structure
pSignature [i] pointer to a valid image structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
The return code will be 0, although one or more compares were not successful, call SPGetCompareResult for details on the compare result.
See also:
SPCompareStaticReference

HRESULT ACTIVESWLib::ISPCompare::CompareStaticTemplate (  [in] ISPTemplate *  pTemplate,
[in] ISPImage *  pSignature,
[out, retval] long *  result
) 
 

compare a static signature with a template

Note:
the final result will alays be 'no match' if the compare modes include SPX_COMPARE_DYNAMIC or SPX_COMPARE_DSTAT
Parameters:
pTemplate [i] pointer to a valid template structure
pSignature [i] pointer to a valid image structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
The return code will be 0, although one or more compares were not successful, call SPGetCompareResult for details on the compare result.
See also:
SPCompareStaticTemplate

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

compare a signature with a template

Note:
the final result will alays be 'no match' if the compare modes include SPX_COMPARE_DYNAMIC and template or signature were capture with a device that has 2 pressure levels, or has no constant sample rate
Parameters:
pTemplate [i] pointer to a valid template structure
pSignature [i] pointer to a valid signature structure
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
The return code will be 0, although one or more compares were not successful, call SPGetCompareResult for details on the compare result.
See also:
SPCompareTemplate, SPX_COMPARE_STATIC, SPX_COMPARE_DYNAMIC, SPX_COMPARE_DESKEW, SetMode

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

Create the comppare instance.

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

HRESULT ACTIVESWLib::ISPCompare::GetDetailResult (  [in] long  lEngine,
[in] long  iIndex,
[out] long *  piResult,
[out, retval] long *  result
) 
 

Get the result for the specified engine.

Parameters:
lEngine [i] Engine specifyer, see SPCompareEngine
iIndex [i] zero based index to address which comparison result to return. Call GetNumResults to query the number of available results for an engine
piResult [o] pointer to an int variable, that will be filled with the result:
  • SPX_INVALIDERR Result not computed
  • SPX_UNSUPPORTEDERR signature or reference do not have required data for the engine
  • < 0: an error occured
  • 0 .. 100: Matchrate, a measure for similarity of signature and reference / template, 0 not similar, 100 similar
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
Some engines provide more than one result per comparison. Use GetNumResults to query the number of available results for the specific engine, and query each detail result for the engine by increasing iIndex parameter
See also:
SPCompareGetDetailResult, GetResult, GetNumResults
Since:
Version 3.2.1

HRESULT ACTIVESWLib::ISPCompare::GetDynamicMatchQuality (  [out] long *  piMinDynamicQuality,
[out, retval] long *  result
) 
 

Get the min. Match rate for dynamic verfication.

Parameters:
piMinDynamicQuality [o] pointer to a variable that will be filled with the min match rate to calculate a verification passed result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
See also:
SPCompareSetDynamicMatchQuality, GetDynamicMatchQuality
Deprecated:
Use ACTIVESWLib::ISPCompare::SetMatchQualityEx

HRESULT ACTIVESWLib::ISPCompare::GetDynamicResult (  [out] long *  piResult,
[out, retval] long *  result
) 
 

Get the result of a dynamic comparison.

Parameters:
piResult [o] pointer to an int variable, that will be filled with the result:
  • SPX_INVALIDERR Result not computed
  • SPX_UNSUPPORTEDERR signature or reference do not have required data for a dynamic comparison
  • < 0: an error occured
  • 0 .. 100: Matchrate, a measure for similarity of signature and reference / template, 0 not similar, 100 similar
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
The threshold for a match is typically set at a matchrate of 80.
See also:
SPCompareGetDynamicResult, GetStaticResult, GetResult
Deprecated:
Use ACTIVESWLib::ISPCompare::GetDetailResult

HRESULT ACTIVESWLib::ISPCompare::GetMatchQuality (  [out] long *  piMinDynamicQuality,
[out] long *  piMinStaticQuality,
[out, retval] long *  result
) 
 

Get the min. Match rate for static and dynamic verfication.

Parameters:
piMinDynamicQuality [o] pointer to a variable that will be filled with the min match rate to calculate a verification passed result
piMinStaticQuality [o] pointer to a variable that will be filled with the min match rate to calculate a verification passed result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
See also:
SPCompareGetMatchQuality, GetMatchQualityEx, SetMatchQualityEx
Deprecated:
Use ACTIVESWLib::ISPCompare::GetMatchQualityEx

HRESULT ACTIVESWLib::ISPCompare::GetMatchQualityEx (  [in] long  lEngine,
[out] long *  piMinQuality,
[out, retval] long *  result
) 
 

Get the min. Match rate for the specified verfication.

Parameters:
lEngine [i] Engine specifyer, see SPCompareEngine
piMinQuality [o] pointer to a variable that will be filled with the min match rate to calculate a verification passed result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
See also:
SPCompareSetMatchQualityEx
Since:
Version 3.2.1

HRESULT ACTIVESWLib::ISPCompare::GetMode (  [out] long *  piMode,
[out, retval] long *  result
) 
 

Get the compare mode.

Parameters:
piMode [o] pointer to a variable, that will be filled with the actual compare mode, SPCompareMode, a combination of the values
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
See also:
SPCompareGetMode, SetMode, SPCompareMode

HRESULT ACTIVESWLib::ISPCompare::GetNumResults (  [in] long  lEngine,
[out] long *  piResult,
[out, retval] long *  result
) 
 

Query the number of available results for the specified engine.

Parameters:
lEngine [i] Engine specifyer, see SPCompareEngine
piResult [o] pointer to an int variable, that will be filled with the number of available results.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
See also:
SPCompareGetNumResults, GetResult, GetDetailResult
Since:
Version 3.2.1

HRESULT ACTIVESWLib::ISPCompare::GetResult (  [out] long *  piResult,
[out, retval] long *  result
) 
 

Get the final result of a comparison.

Parameters:
piResult [o] pointer to an int variable, that will be filled with the final result:
  • -1: Result not computed
  • 0: No match, signature and reference / template are not similar
  • 1: Match, signature and reference / template are similar
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
See also:
SPCompareGetResult, GetDetailResult

HRESULT ACTIVESWLib::ISPCompare::GetStaticMatchQuality (  [out] long *  piMinStaticQuality,
[out, retval] long *  result
) 
 

Get the min. Match rate for static verfication.

Parameters:
piMinStaticQuality [o] pointer to a variable that will be filled with the min match rate to calculate a verification passed result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
See also:
SPCompareSetStaticMatchQuality, SetMatchQualityEx, GetMatchQualityEx
Deprecated:
Use ACTIVESWLib::ISPCompare::GetMatchQualityEx

HRESULT ACTIVESWLib::ISPCompare::GetStaticResult (  [in] long  iIndex,
[out] long *  piResult,
[out, retval] long *  result
) 
 

Get the result of a static comparison.

Parameters:
iIndex [i] index to address which static comparison result to return.
piResult [o] pointer to an int variable, that will be filled with the result:
  • SPX_INVALIDERR Result not computed
  • < 0: an error occured
  • 0 .. 100: Matchrate, a measure for similarity of signature and reference / template, 0 not similar, 100 similar
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
The threshold for a match is typically set at a matchrate of 80.

Static comparison is called for each signature of the reference. The result of each comparison is accessible via parameter iIndex. Please pass iIndex = 0 for the first comparison.
Templates only contain one signature, resulting in one comparison.

See also:
SPCompareGetStaticResult, GetResult, GetDetailResult
Deprecated:
Use ACTIVESWLib::ISPCompare::GetDetailResult

HRESULT ACTIVESWLib::ISPCompare::SetDynamicMatchQuality (  [in] long  iMinDynamicQuality,
[out, retval] long *  result
) 
 

Set the min. Match rate for sdynamic verfication.

Parameters:
iMinDynamicQuality [i] min match rate to calculate a verification passed result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
Defaults for dynamic quality rates are 80. Values must be within 0 and 100.
See also:
SPCompareSetDynamicMatchQuality, SetMatchQualityEx, GetMatchQualityEx, GetResult, GetDetailResult
Deprecated:
Use ACTIVESWLib::ISPCompare::SetMatchQualityEx

HRESULT ACTIVESWLib::ISPCompare::SetMatchQuality (  [in] long  iMinDynamicQuality,
[in] long  iMinStaticQuality,
[out, retval] long *  result
) 
 

Set the min. Match rate for static and dynamic verfication.

Parameters:
iMinDynamicQuality [i] min match rate to calculate a verification passed result
iMinStaticQuality [i] min match rate to calculate a verification passed result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
Defaults for static and dynamic quality rates are 80. Values must be within 0 and 100.
See also:
SPCompareSetMatchQuality, SetMatchQualityEx, GetMatchQualityEx, GetResult, GetDetailResult
Deprecated:
Use ACTIVESWLib::ISPCompare::SetMatchQualityEx

HRESULT ACTIVESWLib::ISPCompare::SetMatchQualityEx (  [in] long  lEngine,
[in] long  iMinQuality,
[out, retval] long *  result
) 
 

Set the min. Match rate for the specified verfication engine.

Parameters:
lEngine [i] Engine specifyer, see SPCompareEngine
iMinQuality [i] min match rate to calculate a verification passed result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
Values must be within 0 and 100.
See also:
SPCompareSetMatchQualityEx, GetResult, GetDetailResult
Since:
Version 3.2.1

HRESULT ACTIVESWLib::ISPCompare::SetMaximumResolution (  [in] long  iMaximumResolution,
[out, retval] long *  result
) 
 

Set the maximum Resolution for signature and reference which are passed to the engines.

The default maximum resolution is 300 DPI.

This parameter will be ignored if the flag SPX_COMPARE_AUTOZOOM is not set

If maximum resolution is set to 0 and flag SPX_COMPARE_AUTOZOOM is set, then signature and reference will be resized to the lower resolution of signature and reference.

Parameters:
iMaximumResolution [i] maximum resolution in DPI, set to 0 to disable a maximum resolution.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
Default: 300 DPI
See also:
SPCompareSetMode, GetMode, SPCompareMode
Since:
Version 3.2.2

HRESULT ACTIVESWLib::ISPCompare::SetMode (  [in] long  iMode,
[out, retval] long *  result
) 
 

Set the compare mode.

Note:
SPX_COMPARE_AUTO_ENGINE may not be combined with SPX_COMPARE_STATIC, SPX_COMPARE_DSTAT or SPX_COMPARE_DYNAMIC.
Parameters:
iMode [i] compare mode, SPCompareMode, a combination of the values
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
Default: SPX_COMPARE_DESKEW | SPX_COMPARE_AUTOZOOM
See also:
SPCompareSetMode, GetMode, SPCompareMode

HRESULT ACTIVESWLib::ISPCompare::SetStaticMatchQuality (  [in] long  iMinStaticQuality,
[out, retval] long *  result
) 
 

Set the min. Match rate for static verfication.

Parameters:
iMinStaticQuality [i] min match rate to calculate a verification passed result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
Note:
Defaults for static quality rates is 80. Values must be within 0 and 100.
See also:
SPCompareSetStaticMatchQuality, SetMatchQualityEx, GetMatchQualityEx, GetResult, GetDetailesult
Deprecated:
Use ACTIVESWLib::ISPCompare::SetMatchQualityEx

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

Pass charged ticket for a compare operation.

Deprecated:
Please use a license key.
Note:
The ticket must be charged for SPX_TICKET_COMPARE_DYNAMIC or SPX_TICKET_COMPARE_STATIC
Parameters:
pTicket [i] ticket
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result, S_OK: success, else automation error code
See also:
SPCompareSetTicket

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