visit Kofax web site
ACTIVESWLib::ISPSignware

ACTIVESWLib::ISPSignware Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPSignwareInterface ISPSignware.

Signware container.


Public Member Functions

HRESULT Base64Decode ([in] BSTR bstrBase64,[out] SAFEARRAY(BYTE)*psaData,[out, retval] long *pnResult)
 Decode a Base64 String.
HRESULT Base64Encode ([in] SAFEARRAY(BYTE) pData,[out] BSTR *bstrBase64,[out, retval] long *pnResult)
 Encode data to a Base64 String.
HRESULT CurrentTime ([out] unsigned long *plTime,[out, retval] long *result)
 Query the current system time.
HRESULT DaysLM ([out] long *iNumDays,[out, retval] long *pnResult)
 Query the number of days until the license expires.
HRESULT GetBrowserTicket ([in] BSTR bstrRequestUrl,[in] ISPTicket *pTicket,[out] BSTR *pbstrTicket,[out, retval] long *pnResult)
 Create a Browser ticket.
HRESULT GetErrorString ([in] long lErrorCode,[out] BSTR *pbstrErrorString,[out, retval] long *pnResult)
 Query a readable string from a SignWare error code.
HRESULT GetInstallationCode ([out] BSTR *pbstrInstallationCode,[out, retval] long *pnResult)
 Query the Installation Code as a string.
HRESULT GetVersionInt ([out] long *pnVersion,[out, retval] long *pnResult)
 Query the Signware Version as an integer.
HRESULT GetVersionStr ([out] BSTR *pbstrVersion,[out, retval] long *pnResult)
 Query the Signware Version as a string.
HRESULT GetVersionStrEx ([in] long iModule,[in] BSTR *pVersion,[out, retval] long *pnResult)
 Query the Signware Version as a string.
HRESULT NeedTicket ([out] long *piNeedTicket,[out, retval] long *result)
 Query if a ticket license is used.
HRESULT SetLicenseKey ([in] SAFEARRAY(BYTE) bKey,[in] BSTR sProduct,[in] BSTR sVersion,[in] SAFEARRAY(BYTE) bToken,[out, retval] long *pnResult)
 Initialize the license manager with a license key.
HRESULT SetLM2 ([in] long uiLmId1,[in] long uiLmId2,[out, retval] long *pnResult)
 Initialize the license manager.
HRESULT SetTicket ([in] ISPTicket *pTicket,[out, retval] long *result)
 Pass charged ticket for a capture operation.
HRESULT Status ([out] long *pnStatus,[out, retval] long *pnResult)
 Query if status of the Signware SDK.
HRESULT ViewLM2 ([in]__int64 hwndParent,[in] BSTR bstrOptions,[out, retval] long *pnResult)
 Popup a dialog to display license information.
HRESULT ViewLM232 ([in]__int32 hwndParent,[in] BSTR bstrOptions,[out, retval] long *pnResult)
 Popup a dialog to display license information.

Member Function Documentation

HRESULT ACTIVESWLib::ISPSignware::Base64Decode (  [in] BSTR  bstrBase64,
[out] SAFEARRAY(BYTE)*  psaData,
[out, retval] long *  pnResult
) 
 

Decode a Base64 String.

Parameters:
bstrBase64 [i] a Base64 encoded string
psaData [o] pointer to a SAFEARRAY that will be filled with the decoded contents of the base64 string
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
See also:
SPBase64Encode

HRESULT ACTIVESWLib::ISPSignware::Base64Encode (  [in] SAFEARRAY(BYTE)  pData,
[out] BSTR *  bstrBase64,
[out, retval] long *  pnResult
) 
 

Encode data to a Base64 String.

Parameters:
pData [i] the data to be Base64 - encoded
bstrBase64 [o] the resulting Base64 encoded string is saved in bstrBase64
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
See also:
SPBase64Encode

HRESULT ACTIVESWLib::ISPSignware::CurrentTime (  [out] unsigned long *  plTime,
[out, retval] long *  result
) 
 

Query the current system time.

Parameters:
plTime [o] pointer to a variable that will be filled with the current time in seconds since 1970-01-01 00:00:00 UTC
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPSignwareGetCurrentTime

HRESULT ACTIVESWLib::ISPSignware::DaysLM (  [out] long *  iNumDays,
[out, retval] long *  pnResult
) 
 

Query the number of days until the license expires.

Parameters:
iNumDays [o] Pointer to an integer that will be filled with the number of days until the license expires. Other return values include:
  • -1 license has expired
  • 0 license expires today
  • 1 license expires tomorrow
  • 0x7FFFFFFF license is unlimited (> 4 years)
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
See also:
SPSignWareDaysLM

HRESULT ACTIVESWLib::ISPSignware::GetBrowserTicket (  [in] BSTR  bstrRequestUrl,
[in] ISPTicket *  pTicket,
[out] BSTR *  pbstrTicket,
[out, retval] long *  pnResult
) 
 

Create a Browser ticket.

Deprecated:
Please use a license key.
Parameters:
bstrRequestUrl [i] the URL that will also be passed to the Browserplugin in the parameter sendTo
pTicket [i] optional License ticket, required if ticket licenses are used, else you may pass NULL. The ticket must be charged with action SP_TICKET_CAPTURE
pbstrTicket [io] a pointer to a string that will be filled with the valid ticket. Pass the result to the browser plugin in the Auth parameter
pnResult [io] pointer to a long that will be filled with the SDK result if the function returns S_OK, <br errors:
Returns:
automation result
Note:
The Kofax capture plugin will request a local license if the parameter Auth is omittet. The plugins will return an error if the parameter Auth is passed but does not contain a valid ticket. The created ticket is valid for the specified request URL only.

HRESULT ACTIVESWLib::ISPSignware::GetErrorString (  [in] long  lErrorCode,
[out] BSTR *  pbstrErrorString,
[out, retval] long *  pnResult
) 
 

Query a readable string from a SignWare error code.

Parameters:
lErrorCode [i] the Signware error code
pbstrErrorString [io] a pointer to a string that will be filled with the error string in english language.
pnResult [io] pointer to a long that will be filled with the SDK result if the function returns S_OK, <br errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPSignware::GetInstallationCode (  [out] BSTR *  pbstrInstallationCode,
[out, retval] long *  pnResult
) 
 

Query the Installation Code as a string.

Parameters:
pbstrInstallationCode,: pointer to a character buffer that will receive the Installation Code
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
See also:
SPSignware::SPSignwareGetInstallationCode

HRESULT ACTIVESWLib::ISPSignware::GetVersionInt (  [out] long *  pnVersion,
[out, retval] long *  pnResult
) 
 

Query the Signware Version as an integer.

Parameters:
pnVersion,: pointer to an integer that will receive the Version
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
See also:
SPSignware::SPSignwareGetVersionInt

HRESULT ACTIVESWLib::ISPSignware::GetVersionStr (  [out] BSTR *  pbstrVersion,
[out, retval] long *  pnResult
) 
 

Query the Signware Version as a string.

Parameters:
pbstrVersion,: pointer to a character buffer that will receive the Version as a string
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
See also:
SPSignware::SPSignwareGetVersionStr

HRESULT ACTIVESWLib::ISPSignware::GetVersionStrEx (  [in] long  iModule,
[in] BSTR *  pVersion,
[out, retval] long *  pnResult
) 
 

Query the Signware Version as a string.

Parameters:
iModule [i] identify the module, where version info is requested
  • SP_SDK_MODULE get version of SignWare
  • SP_GRAPHICS_MODULE get Version of the graphics module
pVersion [o] pointer to a basic string variable that will receive the Version as a string
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code

HRESULT ACTIVESWLib::ISPSignware::NeedTicket (  [out] long *  piNeedTicket,
[out, retval] long *  result
) 
 

Query if a ticket license is used.

Deprecated:
Please use a license key.
Parameters:
piNeedTicket [o] pointer to a long, that will be filled with 0, if no ticket license is used, or 1 if a ticket license is used.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPSignwareNeedTicket

HRESULT ACTIVESWLib::ISPSignware::SetLicenseKey (  [in] SAFEARRAY(BYTE)  bKey,
[in] BSTR  sProduct,
[in] BSTR  sVersion,
[in] SAFEARRAY(BYTE)  bToken,
[out, retval] long *  pnResult
) 
 

Initialize the license manager with a license key.

A license key tells the License Manager which actions are allowed. You can use either a license key for SignWare or a license key for SignDoc SDK.

Parameters:
bKey [i] The license key as array of bytes (ASCII or UTF-8).
sProduct [i] Must be null.
sVersion [i] Must be null.
bToken [i] null or the token. Should be null.
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
Note:
This must be the very first function called in SignWare, else the call will be ignored.

HRESULT ACTIVESWLib::ISPSignware::SetLM2 (  [in] long  uiLmId1,
[in] long  uiLmId2,
[out, retval] long *  pnResult
) 
 

Initialize the license manager.

Note:
The standard SignWare license ID is (809213154, 373825325)
Parameters:
uiLmId1 [i] License ID first part
uiLmId2 [i] License ID second part
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
Note:
This must be the very first function called in SignWare, else the call will be ignored.
Applications only need to initialize the license manager if a personalized license is available, else the standard SignWare license is used.

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

Pass charged ticket for a capture operation.

Deprecated:
Please use a license key.
Parameters:
pTicket [i] ticket
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPSignware::Status (  [out] long *  pnStatus,
[out, retval] long *  pnResult
) 
 

Query if status of the Signware SDK.

Return a flag for the load status of external libraries.

Parameters:
pnStatus,: Pointer to a SPINT32
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
See also:
SPSignware::SPSignwareStatus

HRESULT ACTIVESWLib::ISPSignware::ViewLM2 (  [in] __int64  hwndParent,
[in] BSTR  bstrOptions,
[out, retval] long *  pnResult
) 
 

Popup a dialog to display license information.

Parameters:
hwndParent [i] Parent window handle
bstrOptions [i] a set of additional string parameters, separated by ';' characters
  • option1 the language identifyer for the dialog
    • de german
    • en english (default)
    • uk english
  • option2 The QT version, or empty if this is not a QT application. Pass the QTVersion as the string returned from QApplication::qVersion()
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
See also:
SPSignWareViewLM2

HRESULT ACTIVESWLib::ISPSignware::ViewLM232 (  [in] __int32  hwndParent,
[in] BSTR  bstrOptions,
[out, retval] long *  pnResult
) 
 

Popup a dialog to display license information.

Note:
This method is exclusively for 32-bit applications, it will return an error (SP_PARAMERR) in a 64-bit process
Parameters:
hwndParent [i] Parent window handle
bstrOptions [i] a set of additional string parameters, separated by ';' characters
  • option1 the language identifyer for the dialog
    • de german
    • en english (default)
    • uk english
  • option2 The QT version, or empty if this is not a QT application. Pass the QTVersion as the string returned from QApplication::qVersion()
pnResult [io] pointer to an integer that will be filled with the final result
Returns:
COM result, S_OK: success, else error code
See also:
SPSignWareViewLM2

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