visit Kofax web site
ACTIVESWLib::ISPTeller

ACTIVESWLib::ISPTeller Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPTellerInterface ISPTeller.

Representation of a Teller communication


Public Member Functions

HRESULT ClearWorkspace ([in]__int64 hwnd,[out, retval] long *result)
 Clear the workspace of a SignBase® client.
HRESULT Create ([out, retval] long *result)
 Create the teller instance.
HRESULT DisplayAccount ([in]__int64 hwnd,[out, retval] long *result)
 Display a SignBase® account.
HRESULT DisplayCustomer ([in]__int64 hwnd,[out, retval] long *result)
 Display a SignBase® customer.
HRESULT DisplayVDBForm ([in]__int64 hwnd,[out, retval] long *result)
 Display a SignBase® VDB formular.
HRESULT DisplayVDBFormWithResult ([in]__int64 hwnd,[out, retval] long *result)
 Display a SignBase® VDB formular, return the result.
HRESULT DisplayVDBReference ([in]__int64 hwnd,[out, retval] long *result)
 Display a SignBase® VDB reference.
HRESULT DisplayVDBReferenceWithResult ([in]__int64 hwnd,[out, retval] long *result)
 Display a SignBase® VDB reference, return the result.
HRESULT End ([in]__int64 hwnd,[out, retval] long *result)
 Terminate a SignBase® client.
HRESULT Enroll ([in]__int64 hwnd,[out, retval] long *result)
 Execute a SignBase® client enrollment.
HRESULT GetAccount ([out] BSTR *strName,[out, retval] long *result)
 Query the account for successive SignBase® calls.
HRESULT GetAccountName ([out] BSTR *strName,[out, retval] long *result)
 Query the account name for successive SignBase® calls.
HRESULT GetAmount ([out] __int64 *plAmount,[out, retval] long *result)
 Query the amount for successive SignBase® calls.
HRESULT GetAPSVResult ([out] long *lAPSVResult,[out, retval] long *result)
 Query the APSV result of the last SignBase® call.
HRESULT GetBankCode ([out] BSTR *strName,[out, retval] long *result)
 Query the bank code for successive SignBase® calls.
HRESULT GetBirthDate ([out] BSTR *strName,[out, retval] long *result)
 Query the birth date for successive SignBase® calls.
HRESULT GetBNO ([out] BSTR *strName,[out, retval] long *result)
 Query the BNO for successive SignBase® calls.
HRESULT GetCountry ([out] BSTR *strName,[out, retval] long *result)
 Query the country for successive SignBase® calls.
HRESULT GetCurrency ([out] BSTR *strName,[out, retval] long *result)
 Query the currency for successive SignBase® calls.
HRESULT GetCustomer ([out] BSTR *strName,[out, retval] long *result)
 Query the customer for successive SignBase® calls.
HRESULT GetCustomerName ([out] BSTR *strName,[out, retval] long *result)
 Query the customer name for successive SignBase® calls.
HRESULT GetDocRefNo ([out] BSTR *strName,[out, retval] long *result)
 Query the document reference id for successive SignBase® calls.
HRESULT GetFinalResult ([out] long *lFinalResult,[out, retval] long *result)
 Query the final result of the last SignBase® call.
HRESULT GetFirstname ([out] BSTR *strName,[out, retval] long *result)
 Query the firstname for successive SignBase® calls.
HRESULT GetIndexInPrimaNota ([out] BSTR *strName,[out, retval] long *result)
 Query the document index within a prima nota for successive SignBase® calls.
HRESULT GetLastname ([out] BSTR *strName,[out, retval] long *result)
 Query the lastname for successive SignBase® calls.
HRESULT GetMatchDynamic ([out] long *lMatchDynamic,[out, retval] long *result)
 Query the dynamic match result of the last SignBase® call.
HRESULT GetMatchStatic ([out] long *lMatchStatic,[out, retval] long *result)
 Query the static match result of the last SignBase® call.
HRESULT GetMiddlename ([out] BSTR *strName,[out, retval] long *result)
 Query the middlename for successive SignBase® calls.
HRESULT GetPosition ([out] BSTR *strName,[out, retval] long *result)
 Query the position for successive SignBase® calls.
HRESULT GetPrimaNota ([out] BSTR *strName,[out, retval] long *result)
 Query the prima nota for successive SignBase® calls.
HRESULT GetResult ([out] long *lResult,[out, retval] long *result)
 Query the result of the last SignBase® call.
HRESULT GetReturnImage ([out] char *chType,[out, retval] long *result)
 Query the returned image type for successive SignBase® calls.
HRESULT GetScanDate ([out] BSTR *strName,[out, retval] long *result)
 Query the scan date for successive SignBase® calls.
HRESULT GetSigno ([out] long *lSigno,[out, retval] long *result)
 Query the signo for successive SignBase® calls.
HRESULT GetSignoRole ([out] char *chRole,[out, retval] long *result)
 Query the signo role for successive SignBase® calls.
HRESULT GetSignoStyle ([out] char *chStyle,[out, retval] long *result)
 Query the signo style for successive SignBase® calls.
HRESULT GetSignoType ([out] char *chType,[out, retval] long *result)
 Query the signo type for successive SignBase® calls.
HRESULT GetTellerImage ([out] ISPTellerImage **ti,[out, retval] long *result)
 Query the image for successive SignBase® calls.
HRESULT GetTitle ([out] BSTR *strName,[out, retval] long *result)
 Query the title for successive SignBase® calls.
HRESULT GetTransaction ([out] BSTR *strName,[out, retval] long *result)
 Query the transaction for successive SignBase® calls.
HRESULT GetVPSV ([out] long *pbEnable,[out, retval] long *result)
 Query the VPSV enable flag for successive SignBase® calls.
HRESULT GetXMLSigno ([in]__int64 hwnd,[out, retval] long *result)
 Query a signatory from a SignBase® client.
HRESULT GetXMLString ([out] BSTR *strName,[out, retval] long *result)
 Query the XML data for successive SignBase® calls.
HRESULT Resize ([in]__int64 hwnd,[out, retval] long *result)
 Resize a SignBase® client window.
HRESULT SetAccount ([in] BSTR strName,[out, retval] long *result)
 Set the account for successive SignBase® calls.
HRESULT SetAccountName ([in] BSTR strName,[out, retval] long *result)
 Set the account name for successive SignBase® calls.
HRESULT SetAmount ([in] __int64 lAmount,[out, retval] long *result)
 Set the amount for successive SignBase® calls.
HRESULT SetBankCode ([in] BSTR strName,[out, retval] long *result)
 Set the bank code for successive SignBase® calls.
HRESULT SetBirthDate ([in] BSTR strName,[out, retval] long *result)
 Set the birth date for successive SignBase® calls.
HRESULT SetBNO ([in] BSTR strName,[out, retval] long *result)
 Set the BNO for successive SignBase® calls.
HRESULT SetCoordinates ([in] long lLeft,[in] long lBottom,[in] long lWidth,[in] long lHeight,[out, retval] long *result)
 Set the SignBase® client window size.
HRESULT SetCountry ([in] BSTR strName,[out, retval] long *result)
 Set the country for successive SignBase® calls.
HRESULT SetCurrency ([in] BSTR strName,[out, retval] long *result)
 Set the currency for successive SignBase® calls.
HRESULT SetCustomer ([in] BSTR strName,[out, retval] long *result)
 Set the Customer for successive SignBase® calls.
HRESULT SetCustomerName ([in] BSTR strName,[out, retval] long *result)
 Set the customer name for successive SignBase® calls.
HRESULT SetDocRefNo ([in] BSTR strName,[out, retval] long *result)
 Set the document reference id for successive SignBase® calls.
HRESULT SetFirstname ([in] BSTR strName,[out, retval] long *result)
 Set the firstname for successive SignBase® calls.
HRESULT SetIndexInPrimaNota ([in] BSTR strName,[out, retval] long *result)
 Set the document index within a prima nota for successive SignBase® calls.
HRESULT SetIniFile ([in] BSTR bstrName,[out, retval] long *result)
 Set the configuration file for a SignBase® client.
HRESULT SetLastname ([in] BSTR strName,[out, retval] long *result)
 Set the lastname for successive SignBase® calls.
HRESULT SetMiddlename ([in] BSTR strName,[out, retval] long *result)
 Set the middlename for successive SignBase® calls.
HRESULT SetPosition ([in] BSTR strName,[out, retval] long *result)
 Set the position for successive SignBase® calls.
HRESULT SetPrimaNota ([in] BSTR strName,[out, retval] long *result)
 Set the prima nota for successive SignBase® calls.
HRESULT SetReturnImage ([in] char chPar,[out, retval] long *result)
 Set the returned image type for successive SignBase® calls.
HRESULT SetScanDate ([in] BSTR strName,[out, retval] long *result)
 Set the scan date for successive SignBase® calls.
HRESULT SetSigno ([in] long lSigno,[out, retval] long *result)
 Set the signo for successive SignBase® calls.
HRESULT SetSignoRole ([in] char chPar,[out, retval] long *result)
 Set the signo role for successive SignBase® calls.
HRESULT SetSignoStyle ([in] char chPar,[out, retval] long *result)
 Set the signo style for successive SignBase® calls.
HRESULT SetSignoType ([in] char chPar,[out, retval] long *result)
 Set the signo type for successive SignBase® calls.
HRESULT SetTellerImage ([in] ISPTellerImage *ti,[out, retval] long *result)
 Set the image for successive SignBase® calls.
HRESULT SetTitle ([in] BSTR strName,[out, retval] long *result)
 Set the title for successive SignBase® calls.
HRESULT SetTransaction ([in] BSTR strName,[out, retval] long *result)
 Set the transaction for successive SignBase® calls.
HRESULT SetVPSV ([in] long bEnable,[out, retval] long *result)
 Set the VPSV enable flag for successive SignBase® calls.
HRESULT SetXMLString ([in] BSTR strName,[out, retval] long *result)
 Set the XML data for successive SignBase® calls.
HRESULT Start ([in]__int64 hwnd,[out, retval] long *result)
 Start a SignBase® client.
HRESULT Verify ([in]__int64 hwnd,[out, retval] long *result)
 Execute a SignBase® client verify (STV, SignTellerVerification).
HRESULT XMLCommand ([in]__int64 hwnd, char chAction,[out, retval] long *result)
 Execute a XML command in SignBase®.

Member Function Documentation

HRESULT ACTIVESWLib::ISPTeller::ClearWorkspace (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Clear the workspace of a SignBase® client.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
See also:
SPTellerClearWorkspace

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

Create the teller instance.

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
See also:
SPTellerCreate

HRESULT ACTIVESWLib::ISPTeller::DisplayAccount (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Display a SignBase® account.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
Note:
These parameters are actually passed to SignBase®:
  • BNO
  • BankCode
  • Country
  • Customer
  • Account
Please set the parameters before you call DisplayAccount.
See also:
SetBNO, SetBankCode, SetCountry, SetCustomer, SetAccount
Note:
The detailed result is available with GetResult
See also:
SPTellerDisplayAccount

HRESULT ACTIVESWLib::ISPTeller::DisplayCustomer (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Display a SignBase® customer.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
Note:
These parameters are actually passed to SignBase®:
  • BNO
  • BankCode
  • Country
  • Customer
Please set the parameters before you call DisplayCustomer.
See also:
SetBNO, SetBankCode, SetCountry, SetCustomer
Note:
The detailed result is available with GetResult
See also:
SPTellerDisplayCustomer

HRESULT ACTIVESWLib::ISPTeller::DisplayVDBForm (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Display a SignBase® VDB formular.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
Note:
These parameters are actually passed to SignBase®:
  • Prima nota
  • document index within prima nota
Please set the parameters before you call DisplayVDBForm.
See also:
SetPrimaNota, SetIndexInPrimaNota
Note:
The detailed result is available with GetResult
See also:
SPTellerDisplayVDBForm

HRESULT ACTIVESWLib::ISPTeller::DisplayVDBFormWithResult (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Display a SignBase® VDB formular, return the result.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
Note:
These parameters are actually passed to SignBase®:
  • Prima nota
  • document index within prima nota
Please set the parameters before you call DisplayVDBFormWithResult.
See also:
SetPrimaNota, SetIndexInPrimaNota

SPTellerDisplayVDBFormWithResult

Note:
call GetResult to obtain the result

HRESULT ACTIVESWLib::ISPTeller::DisplayVDBReference (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Display a SignBase® VDB reference.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
Note:
These parameters are actually passed to SignBase®:
  • document refence number
Please set the parameters before you call DisplayVDBReference.
See also:
SetDocRefNo
Note:
The detailed result is available with GetResult
See also:
SPTellerDisplayVDBReference

HRESULT ACTIVESWLib::ISPTeller::DisplayVDBReferenceWithResult (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Display a SignBase® VDB reference, return the result.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
Note:
These parameters are actually passed to SignBase®:
  • document refence number
Please set the parameters before you call DisplayVDBReferenceWithResult.
See also:
SetDocRefNo

SPTellerDisplayVDBReferenceWithResult

Note:
call GetResult to obtain the result

HRESULT ACTIVESWLib::ISPTeller::End (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Terminate a SignBase® client.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
See also:
SPTellerEnd

HRESULT ACTIVESWLib::ISPTeller::Enroll (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Execute a SignBase® client enrollment.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
Note:
These parameters are actually 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 Enroll.
See also:
SetBNO, SetBankCode, SetCountry, SetCurrency, SetCustomer, SetAccount, SetTransaction, SetAmount, SetTellerImage, SetFirstname, SetMiddlename, SetLastname, SetTitle, SetPosition, SetBirthDate, SetScanDate, SetAccountName, SetCustomerName, SetRole, SetStyle, SetType
Note:
The detailed result is available with GetFinalResult

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

See also:
SPTellerEnroll

HRESULT ACTIVESWLib::ISPTeller::GetAccount (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the account for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the account
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetAccount

HRESULT ACTIVESWLib::ISPTeller::GetAccountName (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the account name for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the account name
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetAccountName

HRESULT ACTIVESWLib::ISPTeller::GetAmount (  [out] __int64 *  plAmount,
[out, retval] long *  result
) 
 

Query the amount for successive SignBase® calls.

Parameters:
plAmount [io] a pointer to an __int64 that will be filled with the amount
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetAmount

HRESULT ACTIVESWLib::ISPTeller::GetAPSVResult (  [out] long *  lAPSVResult,
[out, retval] long *  result
) 
 

Query the APSV result of the last SignBase® call.

Parameters:
lAPSVResult [io] pointer to a long that will be filled with the APSV result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetAPSVResult

HRESULT ACTIVESWLib::ISPTeller::GetBankCode (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the bank code for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the bank code
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetBankCode

HRESULT ACTIVESWLib::ISPTeller::GetBirthDate (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the birth date for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the birth date
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetBirthDate

HRESULT ACTIVESWLib::ISPTeller::GetBNO (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the BNO for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the BNO
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetBNO

HRESULT ACTIVESWLib::ISPTeller::GetCountry (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the country for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the country
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetCountry

HRESULT ACTIVESWLib::ISPTeller::GetCurrency (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the currency for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the currency
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetCurrency

HRESULT ACTIVESWLib::ISPTeller::GetCustomer (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the customer for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the customer
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetCustomer

HRESULT ACTIVESWLib::ISPTeller::GetCustomerName (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the customer name for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the customer name
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetCustomerName

HRESULT ACTIVESWLib::ISPTeller::GetDocRefNo (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the document reference id for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the document reference id
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetDocRefNo

HRESULT ACTIVESWLib::ISPTeller::GetFinalResult (  [out] long *  lFinalResult,
[out, retval] long *  result
) 
 

Query the final result of the last SignBase® call.

Parameters:
lFinalResult [io] pointer to a long that will be filled with the final result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetFinalResult

HRESULT ACTIVESWLib::ISPTeller::GetFirstname (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the firstname for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the firstname
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetFirstname

HRESULT ACTIVESWLib::ISPTeller::GetIndexInPrimaNota (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the document index within a prima nota for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the document index
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetIndexInPrimaNota

HRESULT ACTIVESWLib::ISPTeller::GetLastname (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the lastname for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the lastname
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetLastname

HRESULT ACTIVESWLib::ISPTeller::GetMatchDynamic (  [out] long *  lMatchDynamic,
[out, retval] long *  result
) 
 

Query the dynamic match result of the last SignBase® call.

Parameters:
lMatchDynamic [io] pointer to a long that will be filled with the dynamic match result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetMatchDynamic

HRESULT ACTIVESWLib::ISPTeller::GetMatchStatic (  [out] long *  lMatchStatic,
[out, retval] long *  result
) 
 

Query the static match result of the last SignBase® call.

Parameters:
lMatchStatic [io] pointer to a long that will be filled with the static match result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetMatchStatic

HRESULT ACTIVESWLib::ISPTeller::GetMiddlename (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the middlename for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the middlename
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetMiddlename

HRESULT ACTIVESWLib::ISPTeller::GetPosition (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the position for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the position
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetPosition

HRESULT ACTIVESWLib::ISPTeller::GetPrimaNota (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the prima nota for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the prima nota
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetPrimaNota

HRESULT ACTIVESWLib::ISPTeller::GetResult (  [out] long *  lResult,
[out, retval] long *  result
) 
 

Query the result of the last SignBase® call.

Parameters:
lResult [io] pointer to a long that will be filled with the result
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetResult

HRESULT ACTIVESWLib::ISPTeller::GetReturnImage (  [out] char *  chType,
[out, retval] long *  result
) 
 

Query the returned image type for successive SignBase® calls.

Parameters:
chType [io] a pointer to a char that will be filled with the type
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetReturnImage

HRESULT ACTIVESWLib::ISPTeller::GetScanDate (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the scan date for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the scan date
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetScanDate

HRESULT ACTIVESWLib::ISPTeller::GetSigno (  [out] long *  lSigno,
[out, retval] long *  result
) 
 

Query the signo for successive SignBase® calls.

Parameters:
lSigno [io] a pointer to a long that will be filled with the signo
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetSigno

HRESULT ACTIVESWLib::ISPTeller::GetSignoRole (  [out] char *  chRole,
[out, retval] long *  result
) 
 

Query the signo role for successive SignBase® calls.

Parameters:
chRole [io] a pointer to a char that will be filled with the role
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetSignoRole

HRESULT ACTIVESWLib::ISPTeller::GetSignoStyle (  [out] char *  chStyle,
[out, retval] long *  result
) 
 

Query the signo style for successive SignBase® calls.

Parameters:
chStyle [io] a pointer to a char that will be filled with the style
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetSignoStyle

HRESULT ACTIVESWLib::ISPTeller::GetSignoType (  [out] char *  chType,
[out, retval] long *  result
) 
 

Query the signo type for successive SignBase® calls.

Parameters:
chType [io] a pointer to a char that will be filled with the type
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetSignoType

HRESULT ACTIVESWLib::ISPTeller::GetTellerImage (  [out] ISPTellerImage **  ti,
[out, retval] long *  result
) 
 

Query the image for successive SignBase® calls.

Parameters:
ti [io] a pointer to a ISPTellerImage pointer that will be filled with the teller image
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetTellerImage

HRESULT ACTIVESWLib::ISPTeller::GetTitle (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the title for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the title
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetTitle

HRESULT ACTIVESWLib::ISPTeller::GetTransaction (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the transaction for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the transaction
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetTransaction

HRESULT ACTIVESWLib::ISPTeller::GetVPSV (  [out] long *  pbEnable,
[out, retval] long *  result
) 
 

Query the VPSV enable flag for successive SignBase® calls.

Parameters:
pbEnable [io] a pointer to a long that will be filled with the VPSV enable flag
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetEnableVPSV

HRESULT ACTIVESWLib::ISPTeller::GetXMLSigno (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Query a signatory from a SignBase® client.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
Note:
The detailed result is available with GetResult, the result string may be called via GetXMLString

These parameters are actually passed to SignBase®:

  • BNO
  • BankCode
  • Country
  • Customer
  • Account
Please set the parameters before you call GetXMLSigno.
See also:
SetBNO, SetBankCode, SetCountry, SetCustomer, SetAccount

SPTellerGetXMLSigno

HRESULT ACTIVESWLib::ISPTeller::GetXMLString (  [out] BSTR *  strName,
[out, retval] long *  result
) 
 

Query the XML data for successive SignBase® calls.

Parameters:
strName [io] a pointer to a BSTR that will be filled with the XML data
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerGetXMLString

HRESULT ACTIVESWLib::ISPTeller::Resize (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Resize a SignBase® client window.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
See also:
SPTellerResize

HRESULT ACTIVESWLib::ISPTeller::SetAccount (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the account for successive SignBase® calls.

Parameters:
strName [i] the account
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetAccount

HRESULT ACTIVESWLib::ISPTeller::SetAccountName (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the account name for successive SignBase® calls.

Parameters:
strName [i] the account name
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetAccountName

HRESULT ACTIVESWLib::ISPTeller::SetAmount (  [in] __int64  lAmount,
[out, retval] long *  result
) 
 

Set the amount for successive SignBase® calls.

Parameters:
lAmount [i] the amount
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetAmount

HRESULT ACTIVESWLib::ISPTeller::SetBankCode (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the bank code for successive SignBase® calls.

Parameters:
strName [i] the bank code
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetBankCode

HRESULT ACTIVESWLib::ISPTeller::SetBirthDate (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the birth date for successive SignBase® calls.

Parameters:
strName [i] the birth date
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetBirthDate

HRESULT ACTIVESWLib::ISPTeller::SetBNO (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the BNO for successive SignBase® calls.

Parameters:
strName [i] the BNO
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetBNO

HRESULT ACTIVESWLib::ISPTeller::SetCoordinates (  [in] long  lLeft,
[in] long  lBottom,
[in] long  lWidth,
[in] long  lHeight,
[out, retval] long *  result
) 
 

Set the SignBase® client window size.

Parameters:
lLeft [i] left coordinate in screen pixel
lBottom [i] bottom coordinate in screen pixel
lWidth [i] width in screen pixel
lHeight [i] height in screen pixel
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetTellerImage

HRESULT ACTIVESWLib::ISPTeller::SetCountry (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the country for successive SignBase® calls.

Parameters:
strName [i] the country
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetCountry

HRESULT ACTIVESWLib::ISPTeller::SetCurrency (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the currency for successive SignBase® calls.

Parameters:
strName [i] the currency
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetCurrency

HRESULT ACTIVESWLib::ISPTeller::SetCustomer (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the Customer for successive SignBase® calls.

Parameters:
strName [i] the Customer
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetCustomer

HRESULT ACTIVESWLib::ISPTeller::SetCustomerName (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the customer name for successive SignBase® calls.

Parameters:
strName [i] the customer name
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetCustomerName

HRESULT ACTIVESWLib::ISPTeller::SetDocRefNo (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the document reference id for successive SignBase® calls.

Parameters:
strName [i] the diocument reference
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetDocRefId

HRESULT ACTIVESWLib::ISPTeller::SetFirstname (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the firstname for successive SignBase® calls.

Parameters:
strName [i] the firstname
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetFirstname

HRESULT ACTIVESWLib::ISPTeller::SetIndexInPrimaNota (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the document index within a prima nota for successive SignBase® calls.

Parameters:
strName [i] the document index
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetIndexInPrimaNota

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

Set the configuration file for a SignBase® client.

Parameters:
bstrName [i] Name of the configuration file
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
See also:
SPTellerSetIniFile
Note:
Please check the notes in SPTellerSetIniFile

HRESULT ACTIVESWLib::ISPTeller::SetLastname (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the lastname for successive SignBase® calls.

Parameters:
strName [i] the lastname
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetLastname

HRESULT ACTIVESWLib::ISPTeller::SetMiddlename (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the middlename for successive SignBase® calls.

Parameters:
strName [i] the middlename
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetMiddlename

HRESULT ACTIVESWLib::ISPTeller::SetPosition (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the position for successive SignBase® calls.

Parameters:
strName [i] the position
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetPosition

HRESULT ACTIVESWLib::ISPTeller::SetPrimaNota (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the prima nota for successive SignBase® calls.

Parameters:
strName [i] the prima nota
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetPrimaNota

HRESULT ACTIVESWLib::ISPTeller::SetReturnImage (  [in] char  chPar,
[out, retval] long *  result
) 
 

Set the returned image type for successive SignBase® calls.

Parameters:
chPar [i] the type
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetReturnImage

HRESULT ACTIVESWLib::ISPTeller::SetScanDate (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the scan date for successive SignBase® calls.

Parameters:
strName [i] the scan date
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetScanDate

HRESULT ACTIVESWLib::ISPTeller::SetSigno (  [in] long  lSigno,
[out, retval] long *  result
) 
 

Set the signo for successive SignBase® calls.

Parameters:
lSigno [i] the signo
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetSigno

HRESULT ACTIVESWLib::ISPTeller::SetSignoRole (  [in] char  chPar,
[out, retval] long *  result
) 
 

Set the signo role for successive SignBase® calls.

Parameters:
chPar [i] the role
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetSignoRole

HRESULT ACTIVESWLib::ISPTeller::SetSignoStyle (  [in] char  chPar,
[out, retval] long *  result
) 
 

Set the signo style for successive SignBase® calls.

Parameters:
chPar [i] the style
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetSignoStyle

HRESULT ACTIVESWLib::ISPTeller::SetSignoType (  [in] char  chPar,
[out, retval] long *  result
) 
 

Set the signo type for successive SignBase® calls.

Parameters:
chPar [i] the type
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetSignoType

HRESULT ACTIVESWLib::ISPTeller::SetTellerImage (  [in] ISPTellerImage *  ti,
[out, retval] long *  result
) 
 

Set the image for successive SignBase® calls.

Parameters:
ti [i] the teller image
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetTellerImage

HRESULT ACTIVESWLib::ISPTeller::SetTitle (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the title for successive SignBase® calls.

Parameters:
strName [i] the title
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetTitle

HRESULT ACTIVESWLib::ISPTeller::SetTransaction (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the transaction for successive SignBase® calls.

Parameters:
strName [i] the transaction
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetTransaction

HRESULT ACTIVESWLib::ISPTeller::SetVPSV (  [in] long  bEnable,
[out, retval] long *  result
) 
 

Set the VPSV enable flag for successive SignBase® calls.

Parameters:
bEnable [i] the VPSV enable flag
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetEnableVPSV

HRESULT ACTIVESWLib::ISPTeller::SetXMLString (  [in] BSTR  strName,
[out, retval] long *  result
) 
 

Set the XML data for successive SignBase® calls.

Parameters:
strName [i] the XML data
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
Returns:
automation result
See also:
SPTellerSetXMLString

HRESULT ACTIVESWLib::ISPTeller::Start (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Start a SignBase® client.

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
See also:
SPTellerStart

HRESULT ACTIVESWLib::ISPTeller::Verify (  [in] __int64  hwnd,
[out, retval] long *  result
) 
 

Execute a SignBase® client verify (STV, SignTellerVerification).

Parameters:
hwnd [i] The parent window handle, may be 0
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
Note:
These parameters are actually passed to SignBase®:
  • BNO
  • BankCode
  • Country
  • Currency
  • Customer
  • Account
  • Transaction
  • Amount
  • TellerImage
Please set the parameters before you call Verify.
See also:
SetBNO, SetBankCode, SetCountry, SetCurrency, SetCustomer, SetAccount, SetTransaction, SetAmount, SetTellerImage
Note:
The detailed results are available with GetSigno, GetFinalResult, GetAPSVResult, GetMatchStatic, GetMatchDynamic

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

See also:
SPTellerVerify

HRESULT ACTIVESWLib::ISPTeller::XMLCommand (  [in] __int64  hwnd,
char  chAction,
[out, retval] long *  result
) 
 

Execute a XML command in SignBase®.

Parameters:
hwnd [i] The parent window handle, may be 0
chAction [i] action specifier
  • '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" plus "1"
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
  • SP_PARAMERR invalid parameter
  • SP_MEMERR out of memory
Returns:
automation result
Note:
The detailed result is available with GetResult

These parameters are actually passed to SignBase®:

  • XMLString
Please set the parameters before you call XMLCommand.
See also:
SetXMLString

SPTellerXMLCommand

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