visit Kofax web site

SPTeller.h File Reference


Detailed Description

SignWare Dynamic Development toolkit, SPTeller and SPTellerImage objects.

Author:
uko
This header defines two objects: SPTeller uses the SignBase® teller interface to communicate with SignBase®, SPTellerImage converts SignWare objects to the structure required by the SignBase® teller specification. The functions declared in this header are not yet implemented for Linux.

For more information on SignBase® interfaces, please read the appropriate SignBase® documentation; this documentation assumes that you are familiar with SignBase® products and interfaces.

Sample usage:

int VerifySignBase(HWND hParent, pSPSIGNATURE_T pSignature)
{
    pSPTELLERIMAGE_T pTellerImage;
    pSPTELLER_T pTeller;
    int rc = 0;

    rc = SPTellerCreate(&pTeller);
    if(rc != SP_NOERR) return rc;

    // not required, will be called implicitly
    rc = SPTellerStart(pTeller, hParent);
    if(rc != SP_NOERR) {
        SPTellerFree(&pTeller);
        return rc;
    }

    rc = SPTellerImageCreateFromSignature(&pTellerImage, pSignature);
    if(rc != SP_NOERR) {
        SPTellerFree(&pTeller);
        return rc;
    }
    SPTellerSetTellerImage(pTeller, pTellerImage);
    SPTellerImageFree(&psImageData);
    SPTellerSetBNO(pTeller, "myBNO");
    SPTellerSetCountry(pTeller, "myCountry");
    // .. pass all other values

    rc = SPTellerVerify(pTeller, hParent);

    // process the result
    if(rc == SP_NOERR) {
        // check Matches etc
    }

    SPTellerFree(&pTeller);

    return rc;
}

The implementation of the SPTeller object includes the commonly used commands, further commands may be included on request.

This implementation assumes that you use external tools such as "Expat" to create / parse the XML data strings that are passed to or from SignBase®.

Convenience functions SPTellerImageGetXML and SPTellerImageCreateFromXML are included to create a SignPlusSignature from an SPTellerImage object that was created from a reference or a signature object; and to create an SPTellerImage object from a SignPlusSignature XML data stream.

Note:
SPTellerImage objects do not support SPTemplate objects.


Defines

#define SP_TELLER_ACCESS_DENIED_RETURN   'D'
#define SP_TELLER_APSV_OK_RETURN   'd'
#define SP_TELLER_BUSY_RETURN   '1'
#define SP_TELLER_CANCEL_RETURN   'c'
#define SP_TELLER_COMMUNICATION_ERR_RETURN   '3'
#define SP_TELLER_DISABLED_RETURN   'i'
#define SP_TELLER_ERROR_RETURN   'E'
#define SP_TELLER_INITIALIZE_ERR_RETURN   '2'
#define SP_TELLER_LOGGED_RETURN   'A'
#define SP_TELLER_LOGGING_RETURN   'B'
#define SP_TELLER_MATCHERR_RETURN   'b'
#define SP_TELLER_NODATA_RETURN   '4'
#define SP_TELLER_NODYNAVAIL_RETURN   'j'
#define SP_TELLER_NOREFDATA_RETURN   'g'
#define SP_TELLER_NOT_ACCEPTED_RETURN   'a'
#define SP_TELLER_NOT_LOGGED_RETURN   'C'
#define SP_TELLER_NOT_OK_RETURN   'f'
#define SP_TELLER_NOTUSED_RETURN   '7'
#define SP_TELLER_OK_RETURN   '0'
#define SP_TELLER_PARAMETER_ERR_RETURN   '5'
#define SP_TELLER_RIGHTS_ERR_RETURN   '6'
#define SP_TELLER_RULEERR_RETURN   'h'
#define SP_TELLER_UNDEFINED_ERR_RETURN   '9'
#define SP_TELLER_UNSUPPORTED_ERR_RETURN   '8'
#define SP_TELLER_VPSV_OK_RETURN   'e'

Functions

SPINT32 __cdecl SPTellerClearWorkspace (pSPTELLER_T pTeller, SPHWND hwnd)
 Clear the workspace in SignBase®.
SPINT32 __cdecl SPTellerCreate (pSPTELLER_T *ppTeller)
 Create a new SPTeller object for interfacing with SignBase®.
SPINT32 __cdecl SPTellerDisplayAccount (pSPTELLER_T pTeller, SPHWND hwnd)
 Display an account in SignBase®.
SPINT32 __cdecl SPTellerDisplayCustomer (pSPTELLER_T pTeller, SPHWND hwnd)
 Display a customer in SignBase®.
SPINT32 __cdecl SPTellerDisplayVDBForm (pSPTELLER_T pTeller, SPHWND hwnd)
 Display a VDB form in SignBase®.
SPINT32 __cdecl SPTellerDisplayVDBFormWithResult (pSPTELLER_T pTeller, SPHWND hwnd)
 Display a VDB form in SignBase®.
SPINT32 __cdecl SPTellerDisplayVDBReference (pSPTELLER_T pTeller, SPHWND hwnd)
 Display a VDB reference document in SignBase®.
SPINT32 __cdecl SPTellerDisplayVDBReferenceWithResult (pSPTELLER_T pTeller, SPHWND hwnd)
 Display a VDB reference document in SignBase®.
SPINT32 __cdecl SPTellerEnd (pSPTELLER_T pTeller, SPHWND hwnd)
 Terminate a SignBase® client.
SPINT32 __cdecl SPTellerEnroll (pSPTELLER_T pTeller, SPHWND hwnd)
 Perform a SignTeller enrollment.
SPINT32 __cdecl SPTellerFree (pSPTELLER_T *ppTeller)
 Deallocate an SPTeller object.
SPINT32 __cdecl SPTellerFreeString (SPCHAR **ppString)
 Deallocate a string that was allocated by an SPTellerGet function.
SPINT32 __cdecl SPTellerGetAccount (pSPTELLER_T pTeller, SPCHAR **ppszAccount)
 Get the account that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetAccountName (pSPTELLER_T pTeller, SPCHAR **ppszAccountName)
 Get the account name that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetAmount (pSPTELLER_T pTeller, __int64 *pllAmount)
 Get the amount that will be used in subsequent Teller command.
SPINT32 __cdecl SPTellerGetAPSVResult (pSPTELLER_T pTeller, SPINT32 *piAPSVResult)
 Get the APSV result of a Teller command.
SPINT32 __cdecl SPTellerGetBankCode (pSPTELLER_T pTeller, SPCHAR **ppszBankCode)
 Get the bank code that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetBirthDate (pSPTELLER_T pTeller, SPCHAR **ppszBirthDate)
 Get the birth date that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetBNO (pSPTELLER_T pTeller, SPCHAR **ppszBNO)
 Get the BNO that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetCountry (pSPTELLER_T pTeller, SPCHAR **ppszCountry)
 Get the country that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetCurrency (pSPTELLER_T pTeller, SPCHAR **ppszCurrency)
 Get the currency that will be used in subsequent Teller command.
SPINT32 __cdecl SPTellerGetCustomer (pSPTELLER_T pTeller, SPCHAR **ppszCustomer)
 Get the customer that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetCustomerName (pSPTELLER_T pTeller, SPCHAR **ppszCustomerName)
 Get the customer name that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetDocRefNo (pSPTELLER_T pTeller, SPCHAR **ppszDocRefNo)
 Get the document reference ID that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetEnableVPSV (pSPTELLER_T pTeller, SPBOOL *pbEnableVPSV)
 Get the enable VPSV flag that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetFinalResult (pSPTELLER_T pTeller, SPINT32 *piFinalResult)
 Get the final result of a Teller command.
SPINT32 __cdecl SPTellerGetFirstname (pSPTELLER_T pTeller, SPCHAR **ppszFirstname)
 Get the first name that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetIndexInPrimaNota (pSPTELLER_T pTeller, SPCHAR **ppszIndexInPrimaNota)
 Get the relative document index within a prima nota that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetLastname (pSPTELLER_T pTeller, SPCHAR **ppszLastname)
 Get the last name that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetMatchDynamic (pSPTELLER_T pTeller, SPINT32 *piMatchDynamic)
 Get the dynamic match as a result of a Teller command.
SPINT32 __cdecl SPTellerGetMatchStatic (pSPTELLER_T pTeller, SPINT32 *piMatchStatic)
 Get the static match rate as a result of a Teller command.
SPINT32 __cdecl SPTellerGetMiddlename (pSPTELLER_T pTeller, SPCHAR **ppszMiddlename)
 Get the middle name that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetPosition (pSPTELLER_T pTeller, SPCHAR **ppszPosition)
 Get the position that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetPrimaNota (pSPTELLER_T pTeller, SPCHAR **ppszPrimaNota)
 Get the prima nota that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetResult (pSPTELLER_T pTeller, SPINT32 *piResult)
 Get the result code of a Teller command.
SPINT32 __cdecl SPTellerGetReturnImage (pSPTELLER_T pTeller, SPCHAR *pchReturnImage)
 Get the type of returned images that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetScanDate (pSPTELLER_T pTeller, SPCHAR **ppszScanDate)
 Get the scan date that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetSigno (pSPTELLER_T pTeller, SPINT32 *piSigno)
 Get the signo as a result of a Teller command.
SPINT32 __cdecl SPTellerGetSignoRole (pSPTELLER_T pTeller, SPCHAR *pchSignoRole)
 Get the signo role that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetSignoStyle (pSPTELLER_T pTeller, SPCHAR *pchSignoStyle)
 Get the signo style that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetSignoType (pSPTELLER_T pTeller, SPCHAR *pchSignoType)
 Get the signo type that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetTellerImage (pSPTELLER_T pTeller, pSPTELLERIMAGE_T *ppTellerImage)
 Get the SPTellerImage object that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetTitle (pSPTELLER_T pTeller, SPCHAR **ppszTitle)
 Get the title that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetTransaction (pSPTELLER_T pTeller, SPCHAR **ppszTransaction)
 Get the transaction ID that will be used in subsequent Teller commands.
SPINT32 __cdecl SPTellerGetXMLSigno (pSPTELLER_T pTeller, SPHWND hwnd)
 Query an account or customer from SignBase® as an XML string.
SPINT32 __cdecl SPTellerGetXMLString (pSPTELLER_T pTeller, SPCHAR **ppszXML)
 Get the XML string that will be used for further XML commands.
SPINT32 __cdecl SPTellerImageClone (pSPTELLERIMAGE_T pTellerImage, pSPTELLERIMAGE_T *ppClone)
 Create a copy of an SPTellerImage object.
SPINT32 __cdecl SPTellerImageCreateFromImage (pSPTELLERIMAGE_T *ppTellerImage, pSPIMAGE_T pImage)
 Create an SPTellerImage object from on a static signature (image).
SPINT32 __cdecl SPTellerImageCreateFromReference (pSPTELLERIMAGE_T *ppTellerImage, pSPREFERENCE_T pReference)
 Create an SPTellerImage object from a dynamic reference.
SPINT32 __cdecl SPTellerImageCreateFromSignature (pSPTELLERIMAGE_T *ppTellerImage, pSPSIGNATURE_T pSignature)
 Create an SPTellerImage object from a dynamic signature.
SPINT32 __cdecl SPTellerImageCreateFromXML (pSPTELLERIMAGE_T *ppTellerImage, const SPCHAR *pchXML, int iXMLlen)
 Create an SPTellerImage object from an XML document.
SPINT32 __cdecl SPTellerImageFree (pSPTELLERIMAGE_T *ppTellerImage)
 Deallocate an SPTellerImage object.
SPINT32 __cdecl SPTellerImageFreeString (SPCHAR **ppString)
 Free an XML document that was created by SPTellerImageGetXML.
SPINT32 __cdecl SPTellerImageGetSource (pSPTELLERIMAGE_T pTellerImage, SPCHAR *pchSource)
 Get the image source of an SPTellerImage object.
SPINT32 __cdecl SPTellerImageGetType (pSPTELLERIMAGE_T pTellerImage, SPCHAR *pchType)
 Get the image type of an SPTellerImage object.
SPINT32 __cdecl SPTellerImageGetXML (pSPTELLERIMAGE_T pTellerImage, SPINT32 iIndent, SPCHAR **ppString, SPINT32 *piStringLength)
 Convert an SPTellerImage object to an XML document.
SPINT32 __cdecl SPTellerImageSetSource (pSPTELLERIMAGE_T pTellerImage, SPCHAR chSource)
 Set the image source of an SPTellerImage object.
SPINT32 __cdecl SPTellerResize (pSPTELLER_T pTeller, SPHWND hwnd)
 Resize the SignBase® window.
SPINT32 __cdecl SPTellerSetAccount (pSPTELLER_T pTeller, const SPCHAR *pszAccount)
 Set the account number for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetAccountName (pSPTELLER_T pTeller, const SPCHAR *pszAccountName)
 Set the account name for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetAmount (pSPTELLER_T pTeller, __int64 llAmount)
 Set the amount for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetBankCode (pSPTELLER_T pTeller, const SPCHAR *pszBankCode)
 Set the bank code for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetBirthDate (pSPTELLER_T pTeller, const SPCHAR *pszBirthDate)
 Set the birth date for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetBNO (pSPTELLER_T pTeller, const SPCHAR *pszBNO)
 Set the BNO for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetCoordinates (pSPTELLER_T pTeller, SPINT32 iLeft, SPINT32 iBottom, SPINT32 iWidth, SPINT32 iHeight)
 Set the coordinates for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetCountry (pSPTELLER_T pTeller, const SPCHAR *pszCountry)
 Set the country for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetCurrency (pSPTELLER_T pTeller, const SPCHAR *pszCurrency)
 Set the currency for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetCustomer (pSPTELLER_T pTeller, const SPCHAR *pszCustomer)
 Set the customer for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetCustomerName (pSPTELLER_T pTeller, const SPCHAR *pszCustomerName)
 Set the customer name for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetDocRefNo (pSPTELLER_T pTeller, const SPCHAR *pszDocRefNo)
 Set the document reference name for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetEnableVPSV (pSPTELLER_T pTeller, SPBOOL bEnableVPSV)
 Enable VPSV for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetFirstname (pSPTELLER_T pTeller, const SPCHAR *pszFirstname)
 Set the first name for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetIndexInPrimaNota (pSPTELLER_T pTeller, const SPCHAR *pszIndexInPrimaNota)
 Set the document index within a prima nota for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetIniFile (pSPTELLER_T pTeller, const SPCHAR *pszName)
SPINT32 __cdecl SPTellerSetLastname (pSPTELLER_T pTeller, const SPCHAR *pszLastname)
 Set the last name for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetMiddlename (pSPTELLER_T pTeller, const SPCHAR *pszMiddlename)
 Set the middle name for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetPosition (pSPTELLER_T pTeller, const SPCHAR *pszPosition)
 Set the position for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetPrimaNota (pSPTELLER_T pTeller, const SPCHAR *pszPrimaNota)
 Set the prima nota for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetReturnImage (pSPTELLER_T pTeller, SPCHAR chReturnImage)
 Set the type of the returned images for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetScanDate (pSPTELLER_T pTeller, const SPCHAR *pszScanDate)
 Set the scan date for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetSigno (pSPTELLER_T pTeller, SPINT32 iSigno)
 Set the signo for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetSignoRole (pSPTELLER_T pTeller, SPCHAR chSignoRole)
 Set the signo role for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetSignoStyle (pSPTELLER_T pTeller, SPCHAR chSignoStyle)
 Set the signo style for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetSignoType (pSPTELLER_T pTeller, SPCHAR chSignoType)
 Set the signo type for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetTellerImage (pSPTELLER_T pTeller, pSPTELLERIMAGE_T pTellerImage)
 Set the SPTellerImage object for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetTitle (pSPTELLER_T pTeller, const SPCHAR *pszTitle)
 Set the title for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetTransaction (pSPTELLER_T pTeller, const SPCHAR *pszTransaction)
 Set the transaction ID for subsequent Teller commands.
SPINT32 __cdecl SPTellerSetXMLString (pSPTELLER_T pTeller, const SPCHAR *pszXML)
 Set the XML string for subsequent Teller commands.
SPINT32 __cdecl SPTellerStart (pSPTELLER_T pTeller, SPHWND hwnd)
 Start a SignBase® client.
SPINT32 __cdecl SPTellerVerify (pSPTELLER_T pTeller, SPHWND hwnd)
 Perform a SignTeller verification.
SPINT32 __cdecl SPTellerXMLCommand (pSPTELLER_T pTeller, SPHWND hwnd, SPCHAR uchOption)
 Create/modify/delete customer/account/signatory entries in SignBase®.


Define Documentation

#define SP_TELLER_ACCESS_DENIED_RETURN   'D'
 

SignBase® teller command result: an access vialoation occured

#define SP_TELLER_APSV_OK_RETURN   'd'
 

SignBase® teller command result: the signature matched

#define SP_TELLER_BUSY_RETURN   '1'
 

SignBase® teller command result: SignBase® is busy

#define SP_TELLER_CANCEL_RETURN   'c'
 

SignBase® teller command result: the command was cancelled by the user

#define SP_TELLER_COMMUNICATION_ERR_RETURN   '3'
 

SignBase® teller command result: SignBase® communication could be established

#define SP_TELLER_DISABLED_RETURN   'i'
 

SignBase® teller command result: the signature verification is disabled

#define SP_TELLER_ERROR_RETURN   'E'
 

SignBase® teller command result: an undefined error occured

#define SP_TELLER_INITIALIZE_ERR_RETURN   '2'
 

SignBase® teller command result: SignBase® initialization failed

#define SP_TELLER_LOGGED_RETURN   'A'
 

SignBase® teller command result: a user is currently logged in

#define SP_TELLER_LOGGING_RETURN   'B'
 

SignBase® teller command result: a log operation is in progress

#define SP_TELLER_MATCHERR_RETURN   'b'
 

SignBase® teller command result: an error occured during verification of a signature

#define SP_TELLER_NODATA_RETURN   '4'
 

SignBase® teller command result: the command executed successfully, but no data was available

#define SP_TELLER_NODYNAVAIL_RETURN   'j'
 

SignBase® teller command result: the dynamic engine is not accessible

#define SP_TELLER_NOREFDATA_RETURN   'g'
 

SignBase® teller command result: the signature could not be verified, no reference data exists

#define SP_TELLER_NOT_ACCEPTED_RETURN   'a'
 

SignBase® teller command result: the signature did not match

#define SP_TELLER_NOT_LOGGED_RETURN   'C'
 

SignBase® teller command result: no user is currently logged in

#define SP_TELLER_NOT_OK_RETURN   'f'
 

SignBase® teller command result: an error occured during verification

#define SP_TELLER_NOTUSED_RETURN   '7'
 

SignBase® teller command result: the requested action is not available in this state

#define SP_TELLER_OK_RETURN   '0'
 

SignBase® teller command result: the command executed successfully

#define SP_TELLER_PARAMETER_ERR_RETURN   '5'
 

SignBase® teller command result: an illegal parameter was submitted

#define SP_TELLER_RIGHTS_ERR_RETURN   '6'
 

SignBase® teller command result: the currently logged-in user has no rights for the requested command

#define SP_TELLER_RULEERR_RETURN   'h'
 

SignBase® teller command result: the signature could not be verified due to a rule

#define SP_TELLER_UNDEFINED_ERR_RETURN   '9'
 

SignBase® teller command result: the command execution failed

#define SP_TELLER_UNSUPPORTED_ERR_RETURN   '8'
 

SignBase® teller command result: the requested action is not supported

#define SP_TELLER_VPSV_OK_RETURN   'e'
 

SignBase® teller command result: the signature was accepted during VPSV


Function Documentation

SPINT32 __cdecl SPTellerClearWorkspace pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Clear the workspace in SignBase®.

The detailed result is available from SPTellerGetResult.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerCreate pSPTELLER_T ppTeller  ) 
 

Create a new SPTeller object for interfacing with SignBase®.

Parameters:
ppTeller [o] pointer to a variable that will be filled with a pointer to a new SPTeller object. The caller is responsible for deallocating the new object by calling SPTellerFree.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerDisplayAccount pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Display an account in SignBase®.

Currently, these parameters are passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Customer
  • Account
Please set the parameters before you call this function.

The detailed result is available from SPTellerGetResult.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetBNO, SPTellerSetBankCode, SPTellerSetCountry, SPTellerSetCustomer, SPTellerSetAccount

SPINT32 __cdecl SPTellerDisplayCustomer pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Display a customer in SignBase®.

Currently, these parameters are passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Customer
Please set the parameters before you call this function.

The detailed result is available from SPTellerGetResult.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetBNO, SPTellerSetBankCode, SPTellerSetCountry, SPTellerSetCustomer

SPINT32 __cdecl SPTellerDisplayVDBForm pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Display a VDB form in SignBase®.

Currently, these parameters are passed to SignBase®:

  • Prima nota
  • document index within prima nota
Please set the parameters before you call this function.

The detailed result is available from SPTellerGetResult.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetPrimaNota, SPTellerSetIndexInPrimaNota

SPINT32 __cdecl SPTellerDisplayVDBFormWithResult pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Display a VDB form in SignBase®.

Currently, these parameters are passed to SignBase®:

  • Prima nota
  • document index within prima nota
Please set the parameters before you call this function.

The detailed result is available from SPTellerGetResult.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetPrimaNota, SPTellerSetIndexInPrimaNota

SPINT32 __cdecl SPTellerDisplayVDBReference pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Display a VDB reference document in SignBase®.

Currently, these parameters are passed to SignBase®:

  • document refence number
Please set the parameters before you call this function.

The detailed result is available from SPTellerGetResult.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetDocRefNo

SPINT32 __cdecl SPTellerDisplayVDBReferenceWithResult pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Display a VDB reference document in SignBase®.

Currently, these parameters are passed to SignBase®:

  • document refence number
Please set the parameters before you call SPTellerDisplayVDBReferenceWithResult. The detailed result is available from SPTellerGetResult.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetDocRefNo

SPINT32 __cdecl SPTellerEnd pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Terminate a SignBase® client.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerEnroll pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Perform a SignTeller enrollment.

Currently, these parameters are passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Currency
  • Customer
  • Account
  • Lastname
  • Middlename
  • Firstname
  • Title
  • Position
  • Role
  • Style
  • Type
  • BirthDate // Date entries: 'YYYY-MM-DD'
  • ScanDate
  • CustomerType
  • CustomerName
  • AccountName
  • TellerImage
Please set the parameters before you call this function.

The detailed result is available from SPTellerGetFinalResult.

SPTellerEnroll will finally copy the returned data into the pTeller object. Use the parameter get functions to query the updated values.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetBNO, SPTellerSetBankCode, SPTellerSetCountry, SPTellerSetCurrency, SPTellerSetCustomer, SPTellerSetAccount, SPTellerSetTransaction, SPTellerSetAmount, SPTellerSetTellerImage, SPTellerSetFirstname, SPTellerSetMiddlename, SPTellerSetLastname, SPTellerSetTitle, SPTellerSetPosition, SPTellerSetBirthDate, SPTellerSetScanDate, SPTellerSetAccountName, SPTellerSetCustomerName, SPTellerSetSignoRole, SPTellerSetSignoStyle, SPTellerSetSignoType

SPINT32 __cdecl SPTellerFree pSPTELLER_T ppTeller  ) 
 

Deallocate an SPTeller object.

The object must have been created by SPTellerCreate.

Parameters:
ppTeller [io] pointer to a variable containing a pointer to an SPTeller object. The variable will be set to NULL if this function succeeds.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerFreeString SPCHAR **  ppString  ) 
 

Deallocate a string that was allocated by an SPTellerGet function.

Parameters:
ppString [i] pointer to a variable containing a pointer to the string. The variable will be set to NULL if this function succeeds.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetAccount pSPTELLER_T  pTeller,
SPCHAR **  ppszAccount
 

Get the account that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszAccount [o] pointer to a variable that will be filled with the address of an array of characters containing the account as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetAccountName pSPTELLER_T  pTeller,
SPCHAR **  ppszAccountName
 

Get the account name that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszAccountName [o] pointer to a variable that will be filled with the address of an array of characters containing the account name as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetAmount pSPTELLER_T  pTeller,
__int64 *  pllAmount
 

Get the amount that will be used in subsequent Teller command.

Parameters:
pTeller [i] pointer to an SPTeller object.
pllAmount [o] pointer to a variable that will be filled with amount.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetAPSVResult pSPTELLER_T  pTeller,
SPINT32 piAPSVResult
 

Get the APSV result of a Teller command.

Parameters:
pTeller [i] pointer to an SPTeller object.
piAPSVResult [i] pointer to a variable that will be filled with the APSV result.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetBankCode pSPTELLER_T  pTeller,
SPCHAR **  ppszBankCode
 

Get the bank code that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszBankCode [o] pointer to a variable that will be filled with the address of an array of characters containing the bank code as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetBirthDate pSPTELLER_T  pTeller,
SPCHAR **  ppszBirthDate
 

Get the birth date that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszBirthDate [o] pointer to a variable that will be filled with the address of an array of characters containing the birth date (in format YYYY-MM-DD) as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetBNO pSPTELLER_T  pTeller,
SPCHAR **  ppszBNO
 

Get the BNO that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszBNO [o] pointer to a variable that will be filled with the address of an array of characters containing the BNO as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetCountry pSPTELLER_T  pTeller,
SPCHAR **  ppszCountry
 

Get the country that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszCountry [o] pointer to a variable that will be filled with the address of an array of characters containing the country as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetCurrency pSPTELLER_T  pTeller,
SPCHAR **  ppszCurrency
 

Get the currency that will be used in subsequent Teller command.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszCurrency [o] pointer to a variable that will be filled with the address of an array of characters containing the currency as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetCustomer pSPTELLER_T  pTeller,
SPCHAR **  ppszCustomer
 

Get the customer that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszCustomer [o] pointer to a variable that will be filled with the address of an array of characters containing the customer number as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetCustomerName pSPTELLER_T  pTeller,
SPCHAR **  ppszCustomerName
 

Get the customer name that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszCustomerName [o] pointer to a variable that will be filled with the address of an array of characters containing the customer name as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetDocRefNo pSPTELLER_T  pTeller,
SPCHAR **  ppszDocRefNo
 

Get the document reference ID that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszDocRefNo [o] pointer to a variable that will be filled with the address of an array of characters containing the document reference ID as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetEnableVPSV pSPTELLER_T  pTeller,
SPBOOL pbEnableVPSV
 

Get the enable VPSV flag that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pbEnableVPSV [o] pointer to a variable that will be filled with the enable VPSV flag.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetFinalResult pSPTELLER_T  pTeller,
SPINT32 piFinalResult
 

Get the final result of a Teller command.

Parameters:
pTeller [i] pointer to an SPTeller object.
piFinalResult [i] pointer to a variable that will be filled with the final result.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetFirstname pSPTELLER_T  pTeller,
SPCHAR **  ppszFirstname
 

Get the first name that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszFirstname [o] pointer to a variable that will be filled with the address of an array of characters containing the first name as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetIndexInPrimaNota pSPTELLER_T  pTeller,
SPCHAR **  ppszIndexInPrimaNota
 

Get the relative document index within a prima nota that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszIndexInPrimaNota [o] pointer to a variable that will be filled with the address of an array of characters containing the document index within a prima nota as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetLastname pSPTELLER_T  pTeller,
SPCHAR **  ppszLastname
 

Get the last name that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszLastname [o] pointer to a variable that will be filled with the address of an array of characters containing the last name as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetMatchDynamic pSPTELLER_T  pTeller,
SPINT32 piMatchDynamic
 

Get the dynamic match as a result of a Teller command.

Parameters:
pTeller [i] pointer to an SPTeller object.
piMatchDynamic [i] pointer to a variable that will be filled with the dynamic match rate.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetMatchStatic pSPTELLER_T  pTeller,
SPINT32 piMatchStatic
 

Get the static match rate as a result of a Teller command.

Parameters:
pTeller [i] pointer to an SPTeller object.
piMatchStatic [i] pointer to a variable that will be filled with the static match rate.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetMiddlename pSPTELLER_T  pTeller,
SPCHAR **  ppszMiddlename
 

Get the middle name that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszMiddlename [o] pointer to a variable that will be filled with the address of an array of characters containing the middle name as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetPosition pSPTELLER_T  pTeller,
SPCHAR **  ppszPosition
 

Get the position that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszPosition [o] pointer to a variable that will be filled with the address of an array of characters containing the position as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetPrimaNota pSPTELLER_T  pTeller,
SPCHAR **  ppszPrimaNota
 

Get the prima nota that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszPrimaNota [o] pointer to a variable that will be filled with the address of an array of characters containing the prima nota as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetResult pSPTELLER_T  pTeller,
SPINT32 piResult
 

Get the result code of a Teller command.

The result code is the return code of the last Teller command. PLease check the appropriate documentation for description of the return codes.

Parameters:
pTeller [i] pointer to an SPTeller object.
piResult [i] pointer to a variable that will be filled with the result code.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetReturnImage pSPTELLER_T  pTeller,
SPCHAR pchReturnImage
 

Get the type of returned images that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pchReturnImage [o] pointer to a variable that will be filled with the type of returned images.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetReturnImage

SPINT32 __cdecl SPTellerGetScanDate pSPTELLER_T  pTeller,
SPCHAR **  ppszScanDate
 

Get the scan date that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszScanDate [o] pointer to a variable that will be filled with the address of an array of characters containing the scan date (in format YYYY-MM-DD) as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetSigno pSPTELLER_T  pTeller,
SPINT32 piSigno
 

Get the signo as a result of a Teller command.

Parameters:
pTeller [i] pointer to an SPTeller object.
piSigno [i] pointer to a variable that will be filled with the signo.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetSignoRole pSPTELLER_T  pTeller,
SPCHAR pchSignoRole
 

Get the signo role that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pchSignoRole [o] pointer to a variable that will be filled with the signo role.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetSignoStyle pSPTELLER_T  pTeller,
SPCHAR pchSignoStyle
 

Get the signo style that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pchSignoStyle [o] pointer to a variable that will be filled with the signo style.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetSignoType pSPTELLER_T  pTeller,
SPCHAR pchSignoType
 

Get the signo type that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pchSignoType [o] pointer to a variable that will be filled with the signo type.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetTellerImage pSPTELLER_T  pTeller,
pSPTELLERIMAGE_T ppTellerImage
 

Get the SPTellerImage object that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppTellerImage [o] pointer to a variable that will be filled with a pointer to a copy of the SPTellerImage object. The application is responsible for deallocating the object by calling SPTellerImageFree.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetTitle pSPTELLER_T  pTeller,
SPCHAR **  ppszTitle
 

Get the title that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszTitle [o] pointer to a variable that will be filled with the address of an array of characters containing the title as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetTransaction pSPTELLER_T  pTeller,
SPCHAR **  ppszTransaction
 

Get the transaction ID that will be used in subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszTransaction [o] pointer to a variable that will be filled with the address of an array of characters containing the transaction ID as null-terminated ASCII string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerGetXMLSigno pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Query an account or customer from SignBase® as an XML string.

Currently, these parameters are passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Customer
  • Account
  • ReturnImage
Please set the parameters before you call this function.

The detailed result is available from SPTellerGetResult, the result string may be retrieved with SPTellerGetXMLString.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetBNO, SPTellerSetBankCode, SPTellerSetCountry, SPTellerSetCustomer, SPTellerSetAccount, SPTellerSetReturnImage

SPINT32 __cdecl SPTellerGetXMLString pSPTELLER_T  pTeller,
SPCHAR **  ppszXML
 

Get the XML string that will be used for further XML commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
ppszXML [i] pointer to a variable that will be filled with the address of an array of characters containing the null-terminated XML string. The caller is responsible for deallocating the array of characters by calling SPTellerFreeString.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerImageClone pSPTELLERIMAGE_T  pTellerImage,
pSPTELLERIMAGE_T ppClone
 

Create a copy of an SPTellerImage object.

Parameters:
pTellerImage [i] pointer to the SPTellerImage object to be copied.
ppClone [io] pointer to a variable that will be filled with a pointer to a new SPTellerImage object. The caller is responsible for deallocating the new object by calling SPTellerImageFree.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerImageCreateFromImage pSPTELLERIMAGE_T ppTellerImage,
pSPIMAGE_T  pImage
 

Create an SPTellerImage object from on a static signature (image).

Parameters:
ppTellerImage [o] pointer to a variable that will be filled with a pointer to a new SPTellerImage object. The caller is responsible for deallocating the new object by calling SPTellerImageFree.
pImage [i] pointer to an SPImage object.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerImageFree, SPImageSetTellerImage

SPINT32 __cdecl SPTellerImageCreateFromReference pSPTELLERIMAGE_T ppTellerImage,
pSPREFERENCE_T  pReference
 

Create an SPTellerImage object from a dynamic reference.

Parameters:
ppTellerImage [o] pointer to a variable that will be filled with a pointer to a new SPTellerImage object. The caller is responsible for deallocating the new object by calling SPTellerImageFree.
pReference [i] pointer to an SPReference object.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerImageFree, SPReferenceCreateFromTellerImage

SPINT32 __cdecl SPTellerImageCreateFromSignature pSPTELLERIMAGE_T ppTellerImage,
pSPSIGNATURE_T  pSignature
 

Create an SPTellerImage object from a dynamic signature.

Parameters:
ppTellerImage [o] pointer to a variable that will be filled with a pointer to a new SPTellerImage object. The caller is responsible for deallocating the new object by calling SPTellerImageFree.
pSignature [i] pointer to an SPSignature object.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerImageFree, SPSignatureCreateFromTellerImage

SPINT32 __cdecl SPTellerImageCreateFromXML pSPTELLERIMAGE_T ppTellerImage,
const SPCHAR pchXML,
int  iXMLlen
 

Create an SPTellerImage object from an XML document.

The XML document must contain a SignPlusSignature element as defined in signplus.dtd.

Parameters:
ppTellerImage [o] pointer to a variable that will be filled with a pointer to a new SPTellerImage object. The caller is responsible for deallocating the new object by calling SPTellerImageFree.
pchXML [i] pointer to the XML document.
iXMLlen [i] length of the XML document (in bytes) pointed to by pchXML.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerImageFree, SPTellerImageGetXML

SPINT32 __cdecl SPTellerImageFree pSPTELLERIMAGE_T ppTellerImage  ) 
 

Deallocate an SPTellerImage object.

The object must have been created by SPTellerImageClone, SPTellerImageCreateFromSignature, SPTellerImageCreateFromReference, or SPTellerImageCreateFromImage.

Parameters:
ppTellerImage [io] pointer to a variable containing a pointer to an SPTellerImage object. The variable will be set to NULL if this function succeeds.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerImageFreeString SPCHAR **  ppString  ) 
 

Free an XML document that was created by SPTellerImageGetXML.

Parameters:
ppString [ pointer to a variable containing a pointer to the array of characters. The variable will be set to NULL if this function succeeds.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerImageGetSource pSPTELLERIMAGE_T  pTellerImage,
SPCHAR pchSource
 

Get the image source of an SPTellerImage object.

Parameters:
pTellerImage [i] pointer to an SPTellerImage object.
pchSource [io] pointer to a variable that will be filled with the image source. These image sources are defined in SPSigInt.h:
  • SP_IMSOURCE_DEFAULT '0', unspecified source
  • SP_IMSOURCE_FAX '1', facsimile
  • SP_IMSOURCE_OTHER '2', any other source
  • SP_IMSOURCE_MIGRATED '3', image was migrated
  • SP_IMSOURCE_PAYFORM '4', image was scanned from a payform
  • SP_IMSOURCE_PAD '5', pad (dynamic) image
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerImageGetType pSPTELLERIMAGE_T  pTellerImage,
SPCHAR pchType
 

Get the image type of an SPTellerImage object.

Parameters:
pTellerImage [i] pointer to an SPTellerImage object.
pchType [o] pointer to a variable that will be filled with the image type. These types are defined in SPSigInt.h:
  • SP_IMTYPE_NONE '0', no Image
  • SP_IMTYPE_PAD_V1 '1', pad (dynamic) image, version 1
  • SP_IMTYPE_BW '2', black/white image
  • SP_IMTYPE_GRAY '3', gray-scale image
  • SP_IMTYPE_PAD '4', pad (dynamic) image
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerImageGetXML pSPTELLERIMAGE_T  pTellerImage,
SPINT32  iIndent,
SPCHAR **  ppString,
SPINT32 piStringLength
 

Convert an SPTellerImage object to an XML document.

The resulting XML document conforms to signplus.dtd and includes the SignPlusSignature element defined there, but it does not have a prolog.

Parameters:
pTellerImage [i] pointer to an SPTellerImage object.
iIndent [i] the number of spaces used for indentation (or 0 if no indentation is needed).
ppString [o] pointer to a variable that will be filled with the address of an array of characters containing the XML document. The caller is responsible for deallocating the array of characters by calling SPTellerImageFreeString.
piStringLength [o] pointer to a variable that will be filled with the length of the XML document (in bytes).
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerImageFreeString

SPINT32 __cdecl SPTellerImageSetSource pSPTELLERIMAGE_T  pTellerImage,
SPCHAR  chSource
 

Set the image source of an SPTellerImage object.

Parameters:
pTellerImage [i] pointer to an SPTellerImage object.
chSource [i] the image source. These image source are defined in SPSigInt.h:
  • SP_IMSOURCE_DEFAULT '0', unspecified source
  • SP_IMSOURCE_FAX '1', facsimile
  • SP_IMSOURCE_OTHER '2', any other source
  • SP_IMSOURCE_MIGRATED '3', image was migrated
  • SP_IMSOURCE_PAYFORM '4', image was scanned from a payform
  • SP_IMSOURCE_PAD '5', pad (dynamic) image
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerResize pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Resize the SignBase® window.

Currently, these parameters are passed to SignBase®:

  • Left
  • Bottom
  • Width
  • height
Please set the parameters before you call this function. The detailed result is available from SPTellerGetResult.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetCoordinates

SPINT32 __cdecl SPTellerSetAccount pSPTELLER_T  pTeller,
const SPCHAR pszAccount
 

Set the account number for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszAccount [i] pointer to a null-terminated ASCII string containing the account number or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetAccountName pSPTELLER_T  pTeller,
const SPCHAR pszAccountName
 

Set the account name for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszAccountName [i] pointer to a null-terminated ASCII string containing the account name or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetAmount pSPTELLER_T  pTeller,
__int64  llAmount
 

Set the amount for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
llAmount [i] the amount.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetBankCode pSPTELLER_T  pTeller,
const SPCHAR pszBankCode
 

Set the bank code for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszBankCode [i] pointer to a null-terminated ASCII string containing the bank code or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetBirthDate pSPTELLER_T  pTeller,
const SPCHAR pszBirthDate
 

Set the birth date for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszBirthDate [i] pointer to a null-terminated ASCII string containing the birth date (in format YYYY-MM-DD) or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetBNO pSPTELLER_T  pTeller,
const SPCHAR pszBNO
 

Set the BNO for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszBNO [i] pointer to a null-terminated ASCII string containing the BNO or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetCoordinates pSPTELLER_T  pTeller,
SPINT32  iLeft,
SPINT32  iBottom,
SPINT32  iWidth,
SPINT32  iHeight
 

Set the coordinates for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
iLeft [i] the left coordinate (in screen pixels).
iBottom [i] the bottom coordinate (in screen pixels).
iWidth [i] the width (in screen pixels).
iHeight [i] the height (in screen pixels).
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetCountry pSPTELLER_T  pTeller,
const SPCHAR pszCountry
 

Set the country for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszCountry [i] pointer to a null-terminated ASCII string containing the country or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetCurrency pSPTELLER_T  pTeller,
const SPCHAR pszCurrency
 

Set the currency for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszCurrency [i] pointer to a null-terminated ASCII string containing the currency or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetCustomer pSPTELLER_T  pTeller,
const SPCHAR pszCustomer
 

Set the customer for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszCustomer [i] pointer to a null-terminated ASCII string containing the customer number or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetCustomerName pSPTELLER_T  pTeller,
const SPCHAR pszCustomerName
 

Set the customer name for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszCustomerName [i] pointer to a null-terminated ASCII string containing the customer name or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetDocRefNo pSPTELLER_T  pTeller,
const SPCHAR pszDocRefNo
 

Set the document reference name for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszDocRefNo [i] pointer to a null-terminated ASCII string containing the document reference name or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetEnableVPSV pSPTELLER_T  pTeller,
SPBOOL  bEnableVPSV
 

Enable VPSV for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
bEnableVPSV [i] flag to enable VPSV.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetFirstname pSPTELLER_T  pTeller,
const SPCHAR pszFirstname
 

Set the first name for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszFirstname [i] pointer to a null-terminated ASCII string containing the first name or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetIndexInPrimaNota pSPTELLER_T  pTeller,
const SPCHAR pszIndexInPrimaNota
 

Set the document index within a prima nota for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszIndexInPrimaNota [i] pointer to a null-terminated ASCII string containing the document index within a prima nota or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetIniFile pSPTELLER_T  pTeller,
const SPCHAR pszName
 

Set the name of the configuration file of an SPTeller object.

Under Windows, you can only use one ini file per process. The ini file must be set before the very first call to any SignBase® function within that process.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszName [i] pathname of the configuration file to be used. If the pathname does not include a directory, the directories listed in the PATH environment variable will be searched for the file.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetLastname pSPTELLER_T  pTeller,
const SPCHAR pszLastname
 

Set the last name for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszLastname [i] pointer to a null-terminated ASCII string containing the last name or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetMiddlename pSPTELLER_T  pTeller,
const SPCHAR pszMiddlename
 

Set the middle name for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszMiddlename [i] pointer to a null-terminated ASCII string containing the middle name or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetPosition pSPTELLER_T  pTeller,
const SPCHAR pszPosition
 

Set the position for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszPosition [i] pointer to a null-terminated ASCII string containing the position or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetPrimaNota pSPTELLER_T  pTeller,
const SPCHAR pszPrimaNota
 

Set the prima nota for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszPrimaNota [i] pointer to a null-terminated ASCII string containing the prima nota or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetReturnImage pSPTELLER_T  pTeller,
SPCHAR  chReturnImage
 

Set the type of the returned images for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
chReturnImage [i] the type of the returned images or 0 to use the default value. These image types are supported (defined in SPSigInt.h):
  • SP_IMTYPE_NONE no images are returned
  • SP_IMTYPE_BW request a black/white image
  • SP_IMTYPE_GRAY request a gray-scale image
  • SP_IMTYPE_PAD request a 'dynamic' image
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
Todo:
What's a 'dynamic' image?

SPINT32 __cdecl SPTellerSetScanDate pSPTELLER_T  pTeller,
const SPCHAR pszScanDate
 

Set the scan date for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszScanDate [i] pointer to a null-terminated ASCII string containing the scan date (in format YYYY-MM-DD) or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetSigno pSPTELLER_T  pTeller,
SPINT32  iSigno
 

Set the signo for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
iSigno [i] the signo.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetSignoRole pSPTELLER_T  pTeller,
SPCHAR  chSignoRole
 

Set the signo role for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
chSignoRole [i] the role.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetSignoStyle pSPTELLER_T  pTeller,
SPCHAR  chSignoStyle
 

Set the signo style for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
chSignoStyle [i] the signo style.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetSignoType pSPTELLER_T  pTeller,
SPCHAR  chSignoType
 

Set the signo type for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
chSignoType [i] the signo type.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetTellerImage pSPTELLER_T  pTeller,
pSPTELLERIMAGE_T  pTellerImage
 

Set the SPTellerImage object for subsequent Teller commands.

This function copies the SPTellerImage object.

Parameters:
pTeller [i] pointer to an SPTeller object.
pTellerImage [i] pointer to an SPTellerImage object.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetTitle pSPTELLER_T  pTeller,
const SPCHAR pszTitle
 

Set the title for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszTitle [i] pointer to a null-terminated ASCII string containing the title or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetTransaction pSPTELLER_T  pTeller,
const SPCHAR pszTransaction
 

Set the transaction ID for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszTransaction [i] pointer to a null-terminated ASCII string containing the transaction ID or NULL to use the default value.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerSetXMLString pSPTELLER_T  pTeller,
const SPCHAR pszXML
 

Set the XML string for subsequent Teller commands.

Parameters:
pTeller [i] pointer to an SPTeller object.
pszXML [i] the XML string.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerStart pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Start a SignBase® client.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)

SPINT32 __cdecl SPTellerVerify pSPTELLER_T  pTeller,
SPHWND  hwnd
 

Perform a SignTeller verification.

Currently, these parameters are passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Currency
  • Customer
  • Account
  • Transaction
  • Amount
  • TellerImage
Please set the parameters before you call this function.

The detailed results are available from SPTellerGetSigno, SPTellerGetFinalResult, SPTellerGetAPSVResult, SPTellerGetMatchStatic, and SPTellerGetMatchDynamic.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetBNO, SPTellerSetBankCode, SPTellerSetCountry, SPTellerSetCurrency, SPTellerSetCustomer, SPTellerSetAccount, SPTellerSetTransaction, SPTellerSetAmount, SPTellerSetTellerImage

SPINT32 __cdecl SPTellerXMLCommand pSPTELLER_T  pTeller,
SPHWND  hwnd,
SPCHAR  uchOption
 

Create/modify/delete customer/account/signatory entries in SignBase®.

Currently, these parameters are passed to SignBase®:

  • XMLString
Please set the parameters before you call this function.

The detailed result is available from SPTellerGetResult.

Parameters:
pTeller [i] pointer to an SPTeller object.
hwnd [i] window handle of the parent window, may be 0.
uchOption [i] the action to be performed:
  • '1': create a new customer / account / signatory entry, error if existing
  • '2': update a customer / account / signatory entry, create new
  • '3': update a customer / account / signatory entry, error if not existing
  • '4': delete a customer / account / signatory entry, error if not existing
  • '5': update and append a customer / account / signatory entry
  • '6': append a customer / account / signatory entry, don't modify existing
  • '7': combination of actions "4" and "1"
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
SPTellerSetXMLString