visit Kofax web site

SPSignWare.h File Reference


Detailed Description

SignWare Dynamic Development toolkit.

Author:
uko
This header contains global definitions for SignWare.


Data Structures

struct  SP_WEIGHTED_FRAME_S
 A weighted frame. More...
struct  SPRECT_S
 A rectangle bounding a set of pixels. More...

Defines

#define SC_APDU_CASE_1   1
 APDU command specifier: field Lc = 0, Le = 0.
#define SC_APDU_CASE_2_EXT   5
 APDU command specifier: field Lc = 0, Le <= 65536.
#define SC_APDU_CASE_2_SHORT   2
 APDU command specifier: field Lc = 0, Le <= 256.
#define SC_APDU_CASE_3_EXT   6
 APDU command specifier: field Lc <= 65535, Le = 0.
#define SC_APDU_CASE_3_SHORT   3
 APDU command specifier: field Lc <= 255, Le = 0.
#define SC_APDU_CASE_4_EXT   7
 APDU command specifier, field Lc <= 65535, Le <= 65536.
#define SC_APDU_CASE_4_SHORT   4
 APDU command specifier: field Lc <= 255, Le <= 256.
#define SC_APDU_CASE_NONE   0
#define SP_ACTIVE_IMAGE   0
 Image destination on the tablet: active image.
#define SP_ANDROID_TOUCH_DEV   513
 Tablet device ID: mobilephone touch.
#define SP_APPLERR   (-24)
 Error code: Application error.
#define SP_AWT_LOADED   0x40
 Library status flag: external library jawt loaded.
#define SP_BAMBOO_DEV   23
 Tablet device ID: Wacom Bamboo.
#define SP_BLUEM_DEV   16
 Tablet device ID: Stepover blueM - II.
#define SP_BLUEMLCD_DEV   17
 Tablet device ID: Stepover blueM - II.
#define SP_BUFFERERR   (-14)
 Error code: provided buffer is too small.
#define SP_BUSYERR   (-25)
 Error code: Busy error.
#define SP_CANCELERR   (-23)
 Error code: Aborted / cancelled by user.
#define SP_CHECKSUMERR   (-33)
 Error code: Smart card checksum error.
#define SP_CLASSERR   (-2)
 Error code: Java class error.
#define SP_COMMERR   (-21)
 Error code: Cannot setup communication.
#define SP_CORRUPTEDDATAERR   (-15)
 Error code: Provided data is corrupted.
#define SP_CREATEERR   (-18)
 Error code: Cannot create a file.
#define SP_CRYPTERR   (-11)
 Error code: Encryption or decryption failed.
#define SP_DIBERR   (-20)
 Error code: cannot process a bitmap file.
#define SP_DISABLE_CURSOR   0x20
 Draw mode flag: do not draw a pen position; no caret, no emulated cursor.
#define SP_DONT_RENDER_DIRECT   0x100000
 Image format flag: don't use the direct renderer.
#define SP_DONT_RENDER_METAFONT   0x080000
 Image format flag: don't use the METAFONT renderer.
#define SP_DRAW_BACKGROUND_IMAGE   0x40
 Draw mode flag: display the background image.
#define SP_DRAW_BUFFERED   0x800
 Draw Images with double buffering.
#define SP_DRAW_HWND_BORDER   2
 Draw mode flag: draw a border around the window in GUI objects.
#define SP_DRAW_MIRROR_TABLET   0x400
 Mirror the tablet.
#define SP_DRAW_ON_EXT_LCD   0x00000002
 Rectangle flag: draw the rectangle on the tablet device.
#define SP_DRAW_ON_SCREEN   0x00000004
 Rectangle flag: draw the rectangle in the acquiry window.
#define SP_DRAW_TABLET_BORDER   1
 Draw mode flag: draw a border around tablet area in GUI objects.
#define SP_DRAW_TABLET_IMAGE_IN_WINDOW   0x100
 Draw mode flag: draw the tablet image in the acquiry window.
#define SP_DYNAMICERR   (-27)
 Error code: Error in dynamic engine.
#define SP_EID2_DEV   21
 Tablet device ID: Interlink EPad-ID Pro.
#define SP_EID_DEV   12
 Tablet device ID: Interlink EPad-ID.
#define SP_EINK2_DEV   20
 Tablet device ID: Interlink EPad-Ink Pro.
#define SP_EINK_DEV   8
 Tablet device ID: Interlink ePad-ink.
#define SP_EMULATE_PEN_CURSOR   0x10
 Draw mode flag: draw the pen position using an emulated cursor.
#define SP_ENSIGN10_PAD   1001
 Tablet device ID: Euronovate ENSign10.
#define SP_EPAD2_DEV   15
 Tablet device ID: Interlink ePad II.
#define SP_EPADLS_DEV   19
 Tablet device ID: Interlink EPad-LS.
#define SP_EPOS_DEV   6
 Tablet device ID: Interlink ePad POS.
#define SP_ERASE_BACKGROUND   8
 Draw mode flag: let SignWare be responsible for erasing the background of the signature capturing window.
#define SP_ESIG_DEV   7
 Tablet device ID: Interlink ePad E-Signature.
#define SP_FIELDERR   (-4)
 Error code: Java field error.
#define SP_FILEERR   (-26)
 Error code: Unspecified file I/O error.
#define SP_GAWW_EVENTS   0x00000001
 Flag for SPAcquireCreate: use events.
#define SP_GENERIC_DRV   7
 Tablet driver ID: Kofax Generic access module.
#define SP_GRAPHICERR   (-39)
 Error code: Error in graphics engine.
#define SP_GRAPHICLIB_LOADED   0x10
 Library status flag: external image processing library loaded.
#define SP_GRAPHICLIB_MODULE   4
 SignWare module: Graphics engine.
#define SP_GRAPHIRE_DEV   3
 Tablet device ID: Wacom Graphire.
#define SP_HESY_DEV   4
 Tablet device ID: BS Hesy.
#define SP_HTC_P510E_DEV   512
 Tablet device ID: HTC Flyer P510e.
#define SP_HTML5_CAPTURE_DEV   514
 Signature captured through HTML5 capture client.
#define SP_IDCANCEL   2
 SPGuiAcqu capture result: Cancel button.
#define SP_IDENTICERR   (-38)
 Error code: Attempt to compare identical signatures.
#define SP_IDLE_IMAGE   1
 Image destination on the tablet: idle image.
#define SP_IDOK   1
 SPGuiAcqu capture result: OK button.
#define SP_IMAGE_BLACKWHITE   0x010000
 Image format flag: create a black/white image having 8 bits per pixel.
#define SP_IMAGE_BLACKWHITE_1BPP   0x200000
 Image format flag: create a black/white image having 1 bit per pixel.
#define SP_IMAGE_BMP_WIN   1
 Image format: Windows Bitmap.
#define SP_IMAGE_CCITT4   5
 Image format: CCITT4.
#define SP_IMAGE_COLOR   0x400000
 Imaage format flag: create a color image having 24 bit per pixel.
#define SP_IMAGE_CROSSED   0x020000
 Image format flag: draw a cross over the image.
#define SP_IMAGE_GIF   4
 Image format: GIF.
#define SP_IMAGE_JPEG   3
 Image format: JPEG.
#define SP_IMAGE_PNG   8
 Image format: PNG.
#define SP_IMAGE_TIFF   6
 Image format: TIFF.
#define SP_IMAGE_TIFF_LZW   7
 Image format: compressed TIFF.
#define SP_IMMEDIATE_IMAGE   2
 Image destination on the tablet: display image immediately.
#define SP_INGENICO_SC350_DEV   25
 Tablet device ID: Ingenico iSC350.
#define SP_INTERR   (-8)
 Error code: Internal error.
#define SP_INTUOS_DEV   1
 Tablet device ID: Wacom Intuos.
#define SP_INVALIDERR   (-35)
 Error code: Invalid value or operation.
#define SP_IPAD_DEV   501
 Tablet device ID: iPad.
#define SP_IPHONE_DEV   502
 Tablet device ID: iPhone.
#define SP_IPOD_DEV   503
 Tablet device ID: iPod.
#define SP_JAWT_MODULE   6
 SignWare module: java awt library.
#define SP_LICENSEERR   (-34)
 Error code: License error.
#define SP_LINKLIBRARYERR   (-29)
 Error code: Library error.
#define SP_MEMERR   (-6)
 Error code: Out of memory.
#define SP_METHODERR   (-3)
 Error code: Java method error.
#define SP_MOBINETIX_DEV   2
 Tablet device ID: MobiNetix.
#define SP_MTLCD_DEV   13
 Tablet device ID: MotionTouch LegaPad LCD.
#define SP_MTLPD_DEV   14
 Tablet device ID: MotionTouch LegaPad.
#define SP_NATIVE_DRV   3
 Tablet driver ID: Kofax native driver.
#define SP_NOERR   0
 Error code: No error.
#define SP_NOPADERR   (-28)
 Error code: Tablet not accessible.
#define SP_OFFLINEERR   (-31)
 Error code: a device is offline.
#define SP_OLIVETTI_GRAPHOS_A10_DEV   515
 Tablet device ID: Olivetti graphos A10.
#define SP_OLIVETTI_ZPAD_B8001_DEV   510
 Tablet device ID: Olivetti graphos zPad-B8001.
#define SP_ONLY_FOR_EXT_LCD   0x00000008
 Rectangle flag: ignore the rectangle if the tablet does not have an LCD.
#define SP_OPENERR   (-17)
 Error code: Cannot open a file.
#define SP_PADCOM_DRV   2
 Tablet driver ID: MobiNetix driver.
#define SP_PARAMERR   (-1)
 Error code: Parameter error.
#define SP_PENPARTNER_DEV   9
 Tablet device ID: Wacom PenPartner.
#define SP_PL400_DEV   5
 Tablet device ID: Wacom PL400.
#define SP_RELEASE_FOCUS   4
 Draw mode flag: stop acquiry mode when loosing focus in SPGUIAcqu object.
#define SP_REMOTETABLET_DRV   6
 Tablet driver ID: Kofax RemoteTablet driver.
#define SP_SAMSUNG_GT_N7000_DEV   511
 Tablet device ID: Samsung GT-N7000.
#define SP_SDK_LOADED   1
 Library status flag: SignWare library loaded.
#define SP_SDK_MODULE   0
 SignWare module: SignWare proper.
#define SP_SIGNPAD_DEV   22
 Tablet device ID: Wacom SignPad.
#define SP_SIGNWARE_BUILD   BUILD_VERSION
#define SP_SIGNWARE_MAJOR   MAJOR_VERSION
#define SP_SIGNWARE_MINOR   MINOR_VERSION
#define SP_SIGNWARE_REVISION   REVISION_VERSION
#define SP_SMARTCARDERR   (-32)
 Error code: Smart card driver error.
#define SP_STATICERR   (-7)
 Error code: error in static engine.
#define SP_STEPOVER_DEV   11
 Tablet device ID: StepOver.
#define SP_SUPRESS_INPUT   1
#define SP_TABLET_COORDINATE   0x00000001
 Rectangle flag: coordinates are specified in parts per thousand of tablet coordinates.
#define SP_TABLET_HARDWARE_AS_VIRTUAL_BUTTONS   2
 The connected tablet has builtin virtual buttons. A click on a virtual button is passed as a hardware button notification.
#define SP_TABLET_LCD_DISPLAY   1
 SPTablet display type of the connected tablet, the tablet has an integrated LCD display, e.g. Wacom Signpad (STU-500).
#define SP_TABLET_LOGICAL   2
 Request a logical tablet property.
#define SP_TABLET_NO_DISPLAY   0
 SPTablet display type of the connected tablet, the tablet has no display, e.g. Wacom Intuos.
#define SP_TABLET_NO_REALTIME_VECTORS   1
 The connected tablet cannot send signature strokes (vectors) in real time but rather sends all vectors in a block at the end of the capture process.
#define SP_TABLET_PC_DISPLAY   2
 SPTablet display type of the connected tablet, the tablet is integrated into the PC's display, e.g. TabletPC.
#define SP_TABLET_PHYSICAL   1
 Request a physical tablet property.
#define SP_TABLET_SERIAL_TYPE_CUSTOM   1
 Use custom settable device ID.
#define SP_TABLET_SERIAL_TYPE_DEFAULT   0
 Use custom settable device ID if available, the factory set ID otherwise.
#define SP_TABLET_SERIAL_TYPE_FACTORY   2
 Use factory set device ID.
#define SP_TABLETPC_DEV   10
 Tablet device ID: Tablet PC.
#define SP_TABLETSERVER_DRV   5
 Tablet driver ID: Kofax TabletServer driver.
#define SP_TCP_DRV   4
 Tablet driver ID: Kofax remote driver.
#define SP_TEMPLATE_OPTION_BYTE   3
 Template option data type: signed 8-bit integer.
#define SP_TEMPLATE_OPTION_INT   2
 Template option data type: signed 32-bit integer.
#define SP_TEMPLATE_OPTION_SHORT   4
 Template option data type: signed 16-bit integer.
#define SP_TEMPLATE_OPTION_STR   1
 Template option data type: string.
#define SP_TICKET_CAPTURE   9
 Ticket will be used for capturing signatures.
#define SP_TICKET_CLEAN   7
 Ticket will be used for cleaning images using the static engine.
#define SP_TICKET_COMPARE_DYNAMIC   6
 Ticket will be used for comparing signatures with the dynamic engine.
#define SP_TICKET_COMPARE_STATIC   5
 Ticket will be used for comparing signatures with the static engine.
#define SP_TICKET_LOAD_DYNAMIC   3
 Ticket will be used for loading the dynamic engine.
#define SP_TICKET_LOAD_SELF   4
 Ticket will be used for loading the application.
#define SP_TICKET_LOAD_SIGNWARE   1
 Ticket will be used for loading SignWare.
#define SP_TICKET_LOAD_STATIC   2
 Ticket will be used for loading the static engine.
#define SP_TICKET_RENDER   10
 Ticket will be used for rendering a signature.
#define SP_TIMEOUTERR   (-40)
 Error code: a timeout occured.
#define SP_TWAINERR   (-22)
 Error code: An error occured while processing a scanner request.
#define SP_TZSE_DEV   18
 Tablet device ID: Topaz tablet with LCD (and pressure).
#define SP_UNKNOWN_DEV   0
 Tablet device ID: Unknown tablet device.
#define SP_UNKNOWN_DRV   0
 Tablet driver ID: unknown.
#define SP_UNSUPPORTEDERR   (-5)
 Error code: Unsupported device or state.
#define SP_VERIFONE_MX_DEV   24
 Tablet device ID: Verifone MX 800 series.
#define SP_VERSIONERR   (-16)
 Error code: Wrong Version.
#define SP_VIRTUAL_BUTTON_CLICK   0x200
 Draw mode flag: virtual button click mode.
#define SP_VIRTUAL_BUTTON_MODE   0x80
 Draw mode flag: virtual button mode.
#define SP_VPSIGN_PAD   1002
 Tablet device ID: VPSign.
#define SP_WINTAB_DRV   1
 Tablet driver ID: Wintab driver.
#define SPCALLBACK   _cdecl
#define SPEXTERN   extern
#define SPLINK   __cdecl
#define SPXEXPORT   __export
#define SPXIMPORT   extern

Typedefs

typedef SP_WEIGHTED_FRAME_SpSP_WEIGHTED_FRAME_T
 A weighted frame.
typedef SDKACQUIRE_S * pSPACQUIRE_T
 Pointer to an SPAcquire object.
typedef SDKBACKGROUNDOBJECTS_S * pSPBACKGROUNDOBJECTS_T
 Pointer to an SPBackgroundObjects container.
typedef SDKCLEANPARAMETER_S * pSPCLEANPARAMETER_T
 Pointer to an SPCleanParameter object.
typedef SDKCOMPARE_S * pSPCOMPARE_T
 Pointer to an SPCompare object.
typedef SDKGUIACQU_S * pSPGUIACQU_T
 Pointer to an SPGuiAcqu object.
typedef SDKGUICONTAINER_S * pSPGUICONTAINER_T
 Pointer to an SPGuiContainer object.
typedef SDKGUIDISP_S * pSPGUIDISP_T
 Pointer to an SPGuiDisp object.
typedef SDKGUIDYN_S * pSPGUIDYN_T
 Pointer to an SPGuiDyn object.
typedef SDKIMAGE_S * pSPIMAGE_T
 Pointer to an SPImage object.
typedef SDKPROPERTYMAP_S * pSPPROPERTYMAP_T
 Pointer to a PropertyMap object.
typedef SPRECT_SpSPRECT_T
 A rectangle bounding a set of pixels.
typedef SDKREFERENCE_S * pSPREFERENCE_T
 Pointer to an SPReference object.
typedef SDKSCANNER_S * pSPSCANNER_T
 Pointer to a Scanner object.
typedef SDKSCANNERENUM_S * pSPSCANNERENUM_T
 Pointer to a ScannerEnum object.
typedef SDKSIGNATURE_S * pSPSIGNATURE_T
 Pointer to an SPSignature object.
typedef SDKSMARTCARD_S * pSPSMARTCARD_T
 Pointer to an SPSmartCard object.
typedef SDKSMARTCARDDRIVER_S * pSPSMARTCARDDRIVER_T
 Pointer to an SPSmartcardDriver object.
typedef SDKTABLET_S * pSPTABLET_T
 Pointer to an SPTablet object.
typedef SDKTABLETENUM_S * pSPTABLETENUM_T
 Pointer to an SPTabletEnum object.
typedef SDKTELLER_S * pSPTELLER_T
 Pointer to an SPTeller object.
typedef SP_IMAGEDATA_S * pSPTELLERIMAGE_T
 Pointer to a an SPTellerImage object.
typedef SDKTEMPLATE_S * pSPTEMPLATE_T
 Pointer to an SPTemplate object.
typedef SDKTICKET_S * pSPTICKET_T
 Pointer to an SPTicket object.
typedef SP_WEIGHTED_FRAME_S SP_WEIGHTED_FRAME_T
 A weighted frame.
typedef int SPBOOL
 SPBOOL is a boolean.
typedef char SPCHAR
 SPCHAR is an 8-bit character.
typedef double SPDOUBLE
 SPDOUBLE is an IEEE 754 double-precision floating-point number.
typedef float SPFLOAT
 SPFLOAT is an IEEE 754 single-precision floating-point number.
typedef HWND SPHWND
 SPHWND is a window handle.
typedef HINSTANCE SPINSTANCE
 SPINSTANCE is a DLL instance handle.
typedef int SPINT32
 SPINT32 is a 32-bit signed integer.
typedef HMODULE SPMODULE
 SPMODULE is a DLL handle (shared library handle).
typedef SPRECT_S SPRECT_T
 A rectangle bounding a set of pixels.
typedef unsigned char SPUCHAR
 SPUCHAR is an unsigned 8-bit character (byte).
typedef unsigned int SPUINT32
 SPUINT32 is a 32-bit unsigned integer.
typedef void * SPVPTR
 SPVPTR is a void pointer.
typedef wchar_t SPWCHAR
 SPWCHAR is a wide character (16 bits for Windows, 32 bits for Linux).

Functions

SPINT32 __cdecl SPAnsiToUnicode (const SPCHAR *pszAnsi, SPWCHAR **ppUnicode)
 Convert an ANSI string to a Unicode string.
SPINT32 __cdecl SPAnsiToUtf8 (const SPCHAR *pszAnsi, SPCHAR **ppszUtf8)
 Convert an ANSI string to a UTF-8 string.
SPINT32 __cdecl SPAsciiToUnicode (const SPCHAR *pszAnsi, SPWCHAR **ppUnicode)
 Convert an ANSI string to a Unicode string.
SPINT32 __cdecl SPAsciiToUtf8 (const SPCHAR *pszAnsi, SPCHAR **ppszUtf8)
 Convert an ANSI string to a UTF-8 string.
SPINT32 __cdecl SPBase64Decode (const SPCHAR *pszBase64, SPCHAR **ppbData, int *piDataLen)
 Decode a Base64-encoded string.
SPINT32 __cdecl SPBase64Encode (const SPCHAR *pbData, int iDataLen, SPCHAR **ppszBase64)
 Convert binary data to a Base64-encoded string.
SPINT32 __cdecl SPCompress (const SPCHAR *pSrc, SPINT32 iSrcLen, SPCHAR **ppDest, SPINT32 *piDestLen)
 Compress data.
SPINT32 __cdecl SPDecompress (const SPCHAR *pSrc, SPINT32 iSrcLen, SPCHAR **ppDest, SPINT32 *piDestLen)
 Decompress data.
SPINT32 __cdecl SPFreeMemory (SPUCHAR **ppMemory)
 Deallocate an array of frames or split positions.
SPINT32 __cdecl SPFreeString (SPCHAR **ppData)
 Deallocate a string or an array of bytes.
SPINT32 __cdecl SPSignwareCheckLM (SPINT32 iAction)
 Check if a license is available for a certain action.
SPINT32 __cdecl SPSignwareCloseSession (SPINT32 iAction, const SPCHAR *pszSession)
 Inform the License Manager about termination of a session.
SPINT32 __cdecl SPSignwareDaysLM (SPINT32 *piNumDays)
 Get the number of days left until the license expires.
SPINT32 __cdecl SPSignwareGetActualTime (SPUINT32 *piTime)
 Get the current time as a signature timestamp.
SPINT32 __cdecl SPSignwareGetBrowserTicket (const SPCHAR *pszRequestUrl, pSPTICKET_T pTicket, SPCHAR **ppszTicket)
 Create a Browser ticket.
SPINT32 __cdecl SPSignwareGetCurrentTime (SPUINT32 *piTime)
 Get the current time as a signature timestamp.
const SPCHAR *__cdecl SPSignwareGetErrorString (SPINT32 iErrCode)
 Convert a SignWare error code to an English text.
SPINT32 __cdecl SPSignwareGetInstallationCode (SPCHAR *pchInstallationCode, SPINT32 iLen)
 Query the installation code.
SPINT32 __cdecl SPSignwareGetVersionInt (SPINT32 *piVersion)
 Get the SignWare version as an integer.
SPINT32 __cdecl SPSignwareGetVersionStr (SPCHAR *pszVersion, SPINT32 iLen)
 Get the SignWare version as a string.
SPINT32 __cdecl SPSignwareGetVersionStrEx (SPINT32 iModule, SPCHAR *pszVersion, SPINT32 iLen)
 Get the version of a SignWare module as a string.
SPINT32 __cdecl SPSignwareIsCleanParameter (SPVPTR pPtr)
 Check if a SignWare object is an SPCleanParameter object.
SPINT32 __cdecl SPSignwareIsCompare (SPVPTR pPtr)
 Check if a SignWare object is an SPCompare object.
SPINT32 __cdecl SPSignwareIsGuiAcqu (SPVPTR pPtr)
 Check if a SignWare object is an SPGuiAcqu object.
SPINT32 __cdecl SPSignwareIsGuiContainer (SPVPTR pPtr)
 Check if a SignWare object is an SPGuiContainer object.
SPINT32 __cdecl SPSignwareIsGuiDisp (SPVPTR pPtr)
 Check if a SignWare object is an SPGuiDisp object.
SPINT32 __cdecl SPSignwareIsGuiDyn (SPVPTR pPtr)
 Check if a SignWare object is an SPGuiDyn object.
SPINT32 __cdecl SPSignwareIsImage (SPVPTR pPtr)
 Check if a SignWare object is an SPImage object.
SPINT32 __cdecl SPSignwareIsReference (SPVPTR pPtr)
 Check if a SignWare object is an SPReference object.
SPINT32 __cdecl SPSignwareIsScanner (SPVPTR pPtr)
 Check if a SignWare object is an SPScanner object.
SPINT32 __cdecl SPSignwareIsScannerEnum (SPVPTR pPtr)
 Check if a SignWare object is an SPScannerEnum object.
SPINT32 __cdecl SPSignwareIsSignature (SPVPTR pPtr)
 Check if a SignWare object is an SPSignature object.
SPINT32 __cdecl SPSignwareIsSmartcard (SPVPTR pPtr)
 Check if a SignWare object is an SPSmartcard object.
SPINT32 __cdecl SPSignwareIsSmartcardDriver (SPVPTR pPtr)
 Check if a SignWare object is an SPSmartcardDriver object.
SPINT32 __cdecl SPSignwareIsTablet (SPVPTR pPtr)
 Check if a SignWare object is an SPTablet object.
SPINT32 __cdecl SPSignwareIsTabletEnum (SPVPTR pPtr)
 Check if a SignWare object is an SPTabletEnum object.
SPINT32 __cdecl SPSignwareIsTeller (SPVPTR pPtr)
 Check if a SignWare object is an SPTeller object.
SPINT32 __cdecl SPSignwareIsTemplate (SPVPTR pPtr)
 Check if a SignWare object is an SPTemplate object.
SPINT32 __cdecl SPSignwareIsTicket (SPVPTR pPtr)
 Check if a SignWare object is an SPTicket object.
SPINT32 __cdecl SPSignwareNeedTicket (SPINT32 *piNeeded)
 Check if tickets are required for the current license model.
SPINT32 __cdecl SPSignwareOpenSession (SPINT32 iAction, const SPCHAR *pszSession)
 Inform the License Manager about a new session.
SPINT32 __cdecl SPSignwareSetLicenseKey (const void *pKey, SPINT32 iKey, const char *pszProduct, const char *pszVersion, const void *pToken, SPINT32 iToken)
 Set the license key.
SPINT32 __cdecl SPSignwareSetLM2 (SPINT32 iLm2Id_1, SPINT32 iLm2Id_2)
 Set the license ID.
SPINT32 __cdecl SPSignwareSetTicket (pSPTICKET_T pTicket)
 Pass a license ticket.
SPINT32 __cdecl SPSignwareStatus (SPINT32 *piStatus)
 Get the status of the SignWare SDK.
SPINT32 __cdecl SPSignwareViewLM (SPHWND hwndParent)
 Display a dialog box showing license information.
SPINT32 __cdecl SPSignwareViewLM2 (SPHWND hwndParent, const char *pszOptions)
 Display a dialog box showing license information.
SPINT32 __cdecl SPUnicodeToAnsi (const SPWCHAR *pUnicode, SPCHAR **ppszAnsi)
 Convert a Unicode string to an ANSI string.
SPINT32 __cdecl SPUnicodeToAscii (const SPWCHAR *pUnicode, SPCHAR **ppszAnsi)
 Convert a Unicode string to an ANSI string.
SPINT32 __cdecl SPUnicodeToUtf8 (const SPWCHAR *pUnicode, SPCHAR **ppszUtf8)
 Convert a Unicode string to an UTF-8 string.
SPINT32 __cdecl SPUtf8ToAnsi (const SPCHAR *pszUtf8, SPCHAR **ppszAnsi)
 Convert a UTF-8 string to an ANSI string.
SPINT32 __cdecl SPUtf8ToAscii (const SPCHAR *pszUtf8, SPCHAR **ppszAnsi)
 Convert a UTF-8 string to an ANSI string.
SPINT32 __cdecl SPUtf8ToUnicode (const SPCHAR *pszUtf8, SPWCHAR **ppUnicode)
 Convert a UTF-8 string to a Unicode string.


Define Documentation

#define SC_APDU_CASE_1   1
 

APDU command specifier: field Lc = 0, Le = 0.

See also:
SPSmartcardAPDU

#define SC_APDU_CASE_2_EXT   5
 

APDU command specifier: field Lc = 0, Le <= 65536.

Note:
Extended data fields are not supported by all smart cards, it is preferred to call the command several times with a result length of 256 bytes.
See also:
SPSmartcardAPDU

#define SC_APDU_CASE_2_SHORT   2
 

APDU command specifier: field Lc = 0, Le <= 256.

See also:
SPSmartcardAPDU

#define SC_APDU_CASE_3_EXT   6
 

APDU command specifier: field Lc <= 65535, Le = 0.

Note:
Extended data fields are not supported by all smart cards, it is preferred to call the command several times with a command length of 255 bytes.
See also:
SPSmartcardAPDU

#define SC_APDU_CASE_3_SHORT   3
 

APDU command specifier: field Lc <= 255, Le = 0.

See also:
SPSmartcardAPDU

#define SC_APDU_CASE_4_EXT   7
 

APDU command specifier, field Lc <= 65535, Le <= 65536.

Note:
Extended data fields are not supported by all smart cards, it is preferred to call the command several times with a command length of 255 and a result length of 256 bytes.
See also:
SPSmartcardAPDU

#define SC_APDU_CASE_4_SHORT   4
 

APDU command specifier: field Lc <= 255, Le <= 256.

See also:
SPSmartcardAPDU

#define SC_APDU_CASE_NONE   0
 

APDU command specifier: no field Lc, and no field Le.

See also:
SPSmartcardAPDU

#define SP_ACTIVE_IMAGE   0
 

Image destination on the tablet: active image.

The active image is displayed while capturing a signature.

See also:
SPTabletSetBackgroundImage2

#define SP_ANDROID_TOUCH_DEV   513
 

Tablet device ID: mobilephone touch.

Identifier for an android touch device.

See also:
SPTabletGetDevice

#define SP_APPLERR   (-24)
 

Error code: Application error.

The application may not call the function at this time.

#define SP_AWT_LOADED   0x40
 

Library status flag: external library jawt loaded.

See also:
SPSignwareStatus

#define SP_BAMBOO_DEV   23
 

Tablet device ID: Wacom Bamboo.

Identifier for a Wacom Bamboo tablet.

See also:
SPTabletGetDevice

#define SP_BLUEM_DEV   16
 

Tablet device ID: Stepover blueM - II.

Identifier for a stepover blueM II Tablet without LCD.

See also:
SPTabletGetDevice

#define SP_BLUEMLCD_DEV   17
 

Tablet device ID: Stepover blueM - II.

Identifier for a stepover blueM II tablet with LCD.

See also:
SPTabletGetDevice

#define SP_BUFFERERR   (-14)
 

Error code: provided buffer is too small.

The buffer is too small to pass the data.

#define SP_BUSYERR   (-25)
 

Error code: Busy error.

The requested resource or device is currently busy.

#define SP_CANCELERR   (-23)
 

Error code: Aborted / cancelled by user.

The requested action was aborted or cancelled by user.

#define SP_CHECKSUMERR   (-33)
 

Error code: Smart card checksum error.

Error during smart card verify pin commands.

#define SP_CLASSERR   (-2)
 

Error code: Java class error.

A java class is not accessible.

#define SP_COMMERR   (-21)
 

Error code: Cannot setup communication.

Cannot setup a communication to a server.

#define SP_CORRUPTEDDATAERR   (-15)
 

Error code: Provided data is corrupted.

The data is corrupted, e.g. header and body do not match.

#define SP_CREATEERR   (-18)
 

Error code: Cannot create a file.

A file could not be created. Usually due to lack of disk space or missing access rights.

#define SP_CRYPTERR   (-11)
 

Error code: Encryption or decryption failed.

A flat file could not be encrypted or decrypted.

#define SP_DIBERR   (-20)
 

Error code: cannot process a bitmap file.

A DIB (device independant bitmap) operation failed

#define SP_DISABLE_CURSOR   0x20
 

Draw mode flag: do not draw a pen position; no caret, no emulated cursor.

See also:
SPGuiAcquSetDrawMode

#define SP_DONT_RENDER_DIRECT   0x100000
 

Image format flag: don't use the direct renderer.

If this flag is set, the direct (simple) renderer won't be used for rendering a dynamic signature to an image.

See also:
SPSignatureGetImage, SP_DONT_RENDER_METAFONT

#define SP_DONT_RENDER_METAFONT   0x080000
 

Image format flag: don't use the METAFONT renderer.

If this flag is set, the METAFONT renderer won't be used for rendering a dynamic signature to an image.

See also:
SPSignatureGetImage, SP_DONT_RENDER_DIRECT

#define SP_DRAW_BACKGROUND_IMAGE   0x40
 

Draw mode flag: display the background image.

If this flag is set, the background image will be displayed in the SPGuiAcqu window and on the tablet. If this flag is not set, the background image is displayed on the tablet only.

SP_DRAW_ON_SCREEN and SP_DRAW_BACKGROUND_IMAGE are mutually exclusive. Buttons will always be displayed in the window if SP_DRAW_BACKGROUND_IMAGE is set.

This flag is ignored if no background image is set.

See also:
SPGuiAcquSetDrawMode, SP_DRAW_ON_SCREEN

#define SP_DRAW_BUFFERED   0x800
 

Draw Images with double buffering.

Set this flag to reduce flickering.

#define SP_DRAW_HWND_BORDER   2
 

Draw mode flag: draw a border around the window in GUI objects.

See also:
SPGuiAcquSetDrawMode, SPGuiDispSetDrawMode, SPGuiDynSetDrawMode

#define SP_DRAW_MIRROR_TABLET   0x400
 

Mirror the tablet.

Set this flag if the tablet is used upside down, or more precise rotated by 180 degrees. The flag will rotate the background image for the tablet LCD (if applicable) and rotate all vectors received from the tablet.

Note:
This flag is ignored on full screen devices such as TabletPCs.

#define SP_DRAW_ON_EXT_LCD   0x00000002
 

Rectangle flag: draw the rectangle on the tablet device.

This flag only applies to tablets with integrated LCD.

See also:
SPGuiAcquRegisterRect

#define SP_DRAW_ON_SCREEN   0x00000004
 

Rectangle flag: draw the rectangle in the acquiry window.

SP_DRAW_ON_SCREEN and SP_DRAW_BACKGROUND_IMAGE are mutually exclusive.

See also:
SPGuiAcquRegisterRect, SP_DRAW_BACKGROUND_IMAGE

#define SP_DRAW_TABLET_BORDER   1
 

Draw mode flag: draw a border around tablet area in GUI objects.

See also:
SPGuiAcquSetDrawMode, SPGuiDispSetDrawMode

#define SP_DRAW_TABLET_IMAGE_IN_WINDOW   0x100
 

Draw mode flag: draw the tablet image in the acquiry window.

A copy of the image, that was sent to the tablet, will be rendered in the acquiry window, if this fflag is set.

Note:
This flag should normally not be set because it looks nicer if text is directly rendered into the window. It may however be useful to see the tablet's display on the PC for debugging purposes.
See also:
SPGuiAcquSetDrawMode

#define SP_DYNAMICERR   (-27)
 

Error code: Error in dynamic engine.

The dynamic engine returned an error. See the log file for details.

#define SP_EID2_DEV   21
 

Tablet device ID: Interlink EPad-ID Pro.

Identifier for an Interlink EPad-ID Pro tablet.

See also:
SPTabletGetDevice

#define SP_EID_DEV   12
 

Tablet device ID: Interlink EPad-ID.

Identifier for an Interlink EPad-ID tablet.

See also:
SPTabletGetDevice

#define SP_EINK2_DEV   20
 

Tablet device ID: Interlink EPad-Ink Pro.

Identifier for an Interlink EPad-Ink Pro tablet.

See also:
SPTabletGetDevice

#define SP_EINK_DEV   8
 

Tablet device ID: Interlink ePad-ink.

Identifier for an Interlink ePad-ink E-Signature tablet.

See also:
SPTabletGetDevice

#define SP_EMULATE_PEN_CURSOR   0x10
 

Draw mode flag: draw the pen position using an emulated cursor.

See also:
SPGuiAcquSetDrawMode

#define SP_ENSIGN10_PAD   1001
 

Tablet device ID: Euronovate ENSign10.

Identifier for an ENSign10 device.

See also:
SPTabletGetDevice

#define SP_EPAD2_DEV   15
 

Tablet device ID: Interlink ePad II.

Identifier for a Interlink ePad II tablet without LCD.

See also:
SPTabletGetDevice

#define SP_EPADLS_DEV   19
 

Tablet device ID: Interlink EPad-LS.

Identifier for an Interlink EPad-LS tablet.

See also:
SPTabletGetDevice

#define SP_EPOS_DEV   6
 

Tablet device ID: Interlink ePad POS.

Identifier for an Interlink ePad Point Of Sales tablet.

See also:
SPTabletGetDevice

#define SP_ERASE_BACKGROUND   8
 

Draw mode flag: let SignWare be responsible for erasing the background of the signature capturing window.

See also:
SPGuiAcquSetDrawMode

#define SP_ESIG_DEV   7
 

Tablet device ID: Interlink ePad E-Signature.

Identifier for an Interlink ePad Electronic Signature tablet.

See also:
SPTabletGetDevice

#define SP_FIELDERR   (-4)
 

Error code: Java field error.

A java field is not accessible.

#define SP_FILEERR   (-26)
 

Error code: Unspecified file I/O error.

A file I/O operation failed. See the log file for details.

#define SP_GAWW_EVENTS   0x00000001
 

Flag for SPAcquireCreate: use events.

See also:
SPAcquireCreate

#define SP_GENERIC_DRV   7
 

Tablet driver ID: Kofax Generic access module.

Identifier for a Kofax Generic access module.

See also:
SPTabletCreate

#define SP_GRAPHICERR   (-39)
 

Error code: Error in graphics engine.

An error occured in the graphics subsystem. See the log file for details.

#define SP_GRAPHICLIB_LOADED   0x10
 

Library status flag: external image processing library loaded.

SPFreeImage has been loaded.

See also:
SPSignwareStatus

#define SP_GRAPHICLIB_MODULE   4
 

SignWare module: Graphics engine.

See also:
SPSignwareGetVersionStrEx

#define SP_GRAPHIRE_DEV   3
 

Tablet device ID: Wacom Graphire.

Identifier for a Wacom Graphire tablet.

See also:
SPTabletGetDevice

#define SP_HESY_DEV   4
 

Tablet device ID: BS Hesy.

Identifier for a BS Hesy tablet.

See also:
SPTabletGetDevice

#define SP_HTC_P510E_DEV   512
 

Tablet device ID: HTC Flyer P510e.

Identifier for a HTC Flyer P510e device.

See also:
SPTabletGetDevice

#define SP_HTML5_CAPTURE_DEV   514
 

Signature captured through HTML5 capture client.

See also:
SPTabletGetDevice

#define SP_IDCANCEL   2
 

SPGuiAcqu capture result: Cancel button.

See also:
SPGuiAcquAcquireDone

#define SP_IDENTICERR   (-38)
 

Error code: Attempt to compare identical signatures.

#define SP_IDLE_IMAGE   1
 

Image destination on the tablet: idle image.

The idle image is displayed after disconnecting a device.

Note:
Currently, only the Wacom SignPad supports an idle image.
See also:
SPTabletSetBackgroundImage2

#define SP_IDOK   1
 

SPGuiAcqu capture result: OK button.

See also:
SPGuiAcquAcquireDone

#define SP_IMAGE_BLACKWHITE   0x010000
 

Image format flag: create a black/white image having 8 bits per pixel.

If both SP_IMAGE_BLACKWHITE and SP_IMAGE_BLACKWHITE_1BPP are specified, SP_IMAGE_BLACKWHITE_1BPP takes precedence.

See also:
SPBitmapCreateFromFlatFile, SPSignatureGetImage, SPImageSaveInBitmap

#define SP_IMAGE_BLACKWHITE_1BPP   0x200000
 

Image format flag: create a black/white image having 1 bit per pixel.

If both SP_IMAGE_BLACKWHITE and SP_IMAGE_BLACKWHITE_1BPP are specified, SP_IMAGE_BLACKWHITE_1BPP takes precedence.

See also:
SPBitmapCreateFromFlatFile, SPSignatureGetImage

#define SP_IMAGE_BMP_WIN   1
 

Image format: Windows Bitmap.

See also:
SPBitmapCreateFromFlatFile, SPSignatureGetImage, SPImageSaveInBitmap

#define SP_IMAGE_CCITT4   5
 

Image format: CCITT4.

See also:
SPBitmapCreateFromFlatFile, SPSignatureGetImage, SPImageSaveInBitmap

#define SP_IMAGE_COLOR   0x400000
 

Imaage format flag: create a color image having 24 bit per pixel.

Note:
This bit is used internally, don't set this bit.

#define SP_IMAGE_CROSSED   0x020000
 

Image format flag: draw a cross over the image.

See also:
SPBitmapCreateFromFlatFile, SPBitmapCreateFromReference, SPBitmapCreateFromSignature, SPBitmapCreateFromTemplate, SPSignatureGetImage

#define SP_IMAGE_GIF   4
 

Image format: GIF.

See also:
SPBitmapCreateFromFlatFile, SPSignatureGetImage, SPImageSaveInBitmap

#define SP_IMAGE_JPEG   3
 

Image format: JPEG.

See also:
SPBitmapCreateFromFlatFile, SPSignatureGetImage, SPImageSaveInBitmap

#define SP_IMAGE_PNG   8
 

Image format: PNG.

See also:
SPBitmapCreateFromFlatFile, SPSignatureGetImage, SPImageSaveInBitmap

#define SP_IMAGE_TIFF   6
 

Image format: TIFF.

See also:
SPBitmapCreateFromFlatFile, SPSignatureGetImage, SPImageSaveInBitmap

#define SP_IMAGE_TIFF_LZW   7
 

Image format: compressed TIFF.

This format can be used for black/white images only.

See also:
SPBitmapCreateFromFlatFile, SPSignatureGetImage, SPImageSaveInBitmap

#define SP_IMMEDIATE_IMAGE   2
 

Image destination on the tablet: display image immediately.

The immediate image is displayed immediately.

Note:
Currently, only the Wacom SignPad supports an immediate image.
See also:
SPTabletSetBackgroundImage2

#define SP_INGENICO_SC350_DEV   25
 

Tablet device ID: Ingenico iSC350.

Identifier for a Ingenico iSC350 tablet.

See also:
SPTabletGetDevice

#define SP_INTERR   (-8)
 

Error code: Internal error.

An unspecified internal error (such as an unexpected exception) has occurred.

#define SP_INTUOS_DEV   1
 

Tablet device ID: Wacom Intuos.

Identifier for a Wacom Intuos tablet.

See also:
SPTabletGetDevice

#define SP_INVALIDERR   (-35)
 

Error code: Invalid value or operation.

#define SP_IPAD_DEV   501
 

Tablet device ID: iPad.

Identifier for a iPad device.

See also:
SPTabletGetDevice

#define SP_IPHONE_DEV   502
 

Tablet device ID: iPhone.

Identifier for a iPhone device.

See also:
SPTabletGetDevice

#define SP_IPOD_DEV   503
 

Tablet device ID: iPod.

Identifier for a iPod device.

See also:
SPTabletGetDevice

#define SP_JAWT_MODULE   6
 

SignWare module: java awt library.

See also:
SPSignwareGetVersionStrEx

#define SP_LICENSEERR   (-34)
 

Error code: License error.

Missing license for a license-restricted operation. The license is missing, the allowed quota has been exceeded, a ticket has not been set (for the ticket license model), the license has expired, the license cannot be used on this machine, or there is a problem with license setup.

#define SP_LINKLIBRARYERR   (-29)
 

Error code: Library error.

Cannot load a library.

#define SP_MEMERR   (-6)
 

Error code: Out of memory.

The operation could not obtain the required amount of memory.

#define SP_METHODERR   (-3)
 

Error code: Java method error.

A java method is not accessible.

#define SP_MOBINETIX_DEV   2
 

Tablet device ID: MobiNetix.

Identifier for a MobiNetix tablet.

See also:
SPTabletGetDevice

#define SP_MTLCD_DEV   13
 

Tablet device ID: MotionTouch LegaPad LCD.

Identifier for a Motiontouch LegaPad LCD tablet.

See also:
SPTabletGetDevice

#define SP_MTLPD_DEV   14
 

Tablet device ID: MotionTouch LegaPad.

Identifier for a Motiontouch LegaPad tablet without LCD.

See also:
SPTabletGetDevice

#define SP_NATIVE_DRV   3
 

Tablet driver ID: Kofax native driver.

Identifier for a Kofax native driver.

See also:
SPTabletCreate

#define SP_NOERR   0
 

Error code: No error.

The function returned successfully.

#define SP_NOPADERR   (-28)
 

Error code: Tablet not accessible.

The tablet not connected, not installed, or not accessible.

#define SP_OFFLINEERR   (-31)
 

Error code: a device is offline.

#define SP_OLIVETTI_GRAPHOS_A10_DEV   515
 

Tablet device ID: Olivetti graphos A10.

Identifier for a Olivetti Graphos A10

See also:
SPTabletGetDevice

#define SP_OLIVETTI_ZPAD_B8001_DEV   510
 

Tablet device ID: Olivetti graphos zPad-B8001.

Identifier for a Olivetti Graphos zPad-B8001 device.

See also:
SPTabletGetDevice

#define SP_ONLY_FOR_EXT_LCD   0x00000008
 

Rectangle flag: ignore the rectangle if the tablet does not have an LCD.

This flag does not apply to PC displays with integrated capture device (such as Tablet PC).

See also:
SPGuiAcquRegisterRect

#define SP_OPENERR   (-17)
 

Error code: Cannot open a file.

A file does not exist or is not accessible.

#define SP_PADCOM_DRV   2
 

Tablet driver ID: MobiNetix driver.

Identifier for a MobiNetix driver.

See also:
SPTabletCreate

#define SP_PARAMERR   (-1)
 

Error code: Parameter error.

An invalid parameter was passed, for instance:

  • a NULL pointer was passed where a NULL pointer is not allowed
  • a numeric argument is out of range
  • a pointer does not point to an objects of the correct type
  • an object is in a state not supporting the requested operation
  • a buffer length is too small
  • a specified file cannot be opened

#define SP_PENPARTNER_DEV   9
 

Tablet device ID: Wacom PenPartner.

Identifier for a Wacom PenPartner tablet.

See also:
SPTabletGetDevice

#define SP_PL400_DEV   5
 

Tablet device ID: Wacom PL400.

Identifier for a Wacom PL400 or Wacom Cintiq tablet.

See also:
SPTabletGetDevice

#define SP_RELEASE_FOCUS   4
 

Draw mode flag: stop acquiry mode when loosing focus in SPGUIAcqu object.

See also:
SPGuiAcquSetDrawMode

#define SP_REMOTETABLET_DRV   6
 

Tablet driver ID: Kofax RemoteTablet driver.

Identifier for a Kofax RemoteTablet driver.

See also:
SPTabletCreate

#define SP_SAMSUNG_GT_N7000_DEV   511
 

Tablet device ID: Samsung GT-N7000.

Identifier for a Samsung GT-N7000 device.

See also:
SPTabletGetDevice

#define SP_SDK_LOADED   1
 

Library status flag: SignWare library loaded.

See also:
SPSignwareStatus

#define SP_SDK_MODULE   0
 

SignWare module: SignWare proper.

See also:
SPSignwareGetVersionStrEx

#define SP_SIGNPAD_DEV   22
 

Tablet device ID: Wacom SignPad.

Identifier for a Wacom SignPad tablet with LCD.

See also:
SPTabletGetDevice

#define SP_SIGNWARE_BUILD   BUILD_VERSION
 

Signware Core Build Version

#define SP_SIGNWARE_MAJOR   MAJOR_VERSION
 

Signware Core Major Version

#define SP_SIGNWARE_MINOR   MINOR_VERSION
 

Signware Core Minor Version

#define SP_SIGNWARE_REVISION   REVISION_VERSION
 

Signware Core Revision Version

#define SP_SMARTCARDERR   (-32)
 

Error code: Smart card driver error.

Error when calling the smart card driver.

#define SP_STATICERR   (-7)
 

Error code: error in static engine.

The static engine returned an error. See the log file for details.

#define SP_STEPOVER_DEV   11
 

Tablet device ID: StepOver.

Identifier for a StepOver tablet.

See also:
SPTabletGetDevice

#define SP_SUPRESS_INPUT   1
 

SPSmartcardGetInput: echo input as asteriks.

See also:
SPSmartcardGetInput

#define SP_TABLET_COORDINATE   0x00000001
 

Rectangle flag: coordinates are specified in parts per thousand of tablet coordinates.

See also:
SPGuiAcquRegisterRect

#define SP_TABLET_HARDWARE_AS_VIRTUAL_BUTTONS   2
 

The connected tablet has builtin virtual buttons. A click on a virtual button is passed as a hardware button notification.

See also:
SPTabletGetTabletType, pSPTABLETBUTTON_T

#define SP_TABLET_LCD_DISPLAY   1
 

SPTablet display type of the connected tablet, the tablet has an integrated LCD display, e.g. Wacom Signpad (STU-500).

See also:
SPTabletSetDisplayType, SPTabletGetDisplayType

#define SP_TABLET_LOGICAL   2
 

Request a logical tablet property.

See also:
SPTabletGetResolution2, SPTabletGetSampleRate2

#define SP_TABLET_NO_DISPLAY   0
 

SPTablet display type of the connected tablet, the tablet has no display, e.g. Wacom Intuos.

See also:
SPTabletSetDisplayType, SPTabletGetDisplayType

#define SP_TABLET_NO_REALTIME_VECTORS   1
 

The connected tablet cannot send signature strokes (vectors) in real time but rather sends all vectors in a block at the end of the capture process.

See also:
SPTabletGetTabletType

#define SP_TABLET_PC_DISPLAY   2
 

SPTablet display type of the connected tablet, the tablet is integrated into the PC's display, e.g. TabletPC.

See also:
SPTabletSetDisplayType, SPTabletGetDisplayType

#define SP_TABLET_PHYSICAL   1
 

Request a physical tablet property.

See also:
SPTabletGetResolution2, SPTabletGetSampleRate2

#define SP_TABLET_SERIAL_TYPE_CUSTOM   1
 

Use custom settable device ID.

#define SP_TABLET_SERIAL_TYPE_DEFAULT   0
 

Use custom settable device ID if available, the factory set ID otherwise.

#define SP_TABLET_SERIAL_TYPE_FACTORY   2
 

Use factory set device ID.

#define SP_TABLETPC_DEV   10
 

Tablet device ID: Tablet PC.

Identifier for a Tablet PC (capture device integrated).

See also:
SPTabletGetDevice

#define SP_TABLETSERVER_DRV   5
 

Tablet driver ID: Kofax TabletServer driver.

Identifier for a Kofax TabletServer driver.

See also:
SPTabletCreate

#define SP_TCP_DRV   4
 

Tablet driver ID: Kofax remote driver.

Identifier for a Kofax remote driver.

See also:
SPTabletCreate

#define SP_TEMPLATE_OPTION_BYTE   3
 

Template option data type: signed 8-bit integer.

The range of a signed 8-bit integer is -128 through 127.

See also:
SPTemplateAddOption, SPTemplateGetOption

#define SP_TEMPLATE_OPTION_INT   2
 

Template option data type: signed 32-bit integer.

See also:
SPTemplateAddOption, SPTemplateGetOption

#define SP_TEMPLATE_OPTION_SHORT   4
 

Template option data type: signed 16-bit integer.

See also:
SPTemplateAddOption, SPTemplateGetOption

#define SP_TEMPLATE_OPTION_STR   1
 

Template option data type: string.

Strings are null-terminated, any encoding can be used. The length (excluding null termination) must not exceed 32762.

See also:
SPTemplateAddOption, SPTemplateGetOption

#define SP_TICKET_CAPTURE   9
 

Ticket will be used for capturing signatures.

See also:
SPSignwareSetTicket, SPGuiAcquSetTicket, SPTabletSetTicket

#define SP_TICKET_CLEAN   7
 

Ticket will be used for cleaning images using the static engine.

See also:
SPSignwareSetTicket, SPImageCleanBatch, SPImageCleanLines, SPImageCleanFrames

#define SP_TICKET_COMPARE_DYNAMIC   6
 

Ticket will be used for comparing signatures with the dynamic engine.

See also:
SPSignwareSetTicket

#define SP_TICKET_COMPARE_STATIC   5
 

Ticket will be used for comparing signatures with the static engine.

See also:
SPSignwareSetTicket

#define SP_TICKET_LOAD_DYNAMIC   3
 

Ticket will be used for loading the dynamic engine.

See also:
SPSignwareSetTicket

#define SP_TICKET_LOAD_SELF   4
 

Ticket will be used for loading the application.

Use SP_TICKET_LOAD_SELF only if you have a personalized license ID.

See also:
SPSignwareSetTicket, SPSignwareSetLM2

#define SP_TICKET_LOAD_SIGNWARE   1
 

Ticket will be used for loading SignWare.

See also:
SPSignwareSetTicket

#define SP_TICKET_LOAD_STATIC   2
 

Ticket will be used for loading the static engine.

See also:
SPSignwareSetTicket

#define SP_TICKET_RENDER   10
 

Ticket will be used for rendering a signature.

See also:
SPSignatureSetTicket, SPSignatureGetImage

#define SP_TIMEOUTERR   (-40)
 

Error code: a timeout occured.

#define SP_TWAINERR   (-22)
 

Error code: An error occured while processing a scanner request.

Cannot process a scanner capture request.

#define SP_TZSE_DEV   18
 

Tablet device ID: Topaz tablet with LCD (and pressure).

Identifier for a Topaz tablet with LCD (and pressure).

See also:
SPTabletGetDevice

#define SP_UNKNOWN_DEV   0
 

Tablet device ID: Unknown tablet device.

Identifier for an unknown tablet device.

See also:
SPTabletGetDevice

#define SP_UNKNOWN_DRV   0
 

Tablet driver ID: unknown.

Identifier for an unknown tablet driver.

See also:
SPTabletCreate

#define SP_UNSUPPORTEDERR   (-5)
 

Error code: Unsupported device or state.

The operation could not access the requested device or an object is in a state not supporting the requested operation.

#define SP_VERIFONE_MX_DEV   24
 

Tablet device ID: Verifone MX 800 series.

Identifier for a Verifone MX tablet.

See also:
SPTabletGetDevice

#define SP_VERSIONERR   (-16)
 

Error code: Wrong Version.

A library was found, but it does not have the correct version.

#define SP_VIRTUAL_BUTTON_CLICK   0x200
 

Draw mode flag: virtual button click mode.

if this flag is set then virtual buttons are clicked when the pen is pressed and released in the virtual button region.
if this flag is not set then virtual buttons are clicked when the pen is pressed in the virtual button region

See also:
SPGuiAcquSetDrawMode

#define SP_VIRTUAL_BUTTON_MODE   0x80
 

Draw mode flag: virtual button mode.

In virtual button mode, strokes are neither displayed nor processed, except for clicks on virtual buttons (events will be sent for clicks on virtual buttons).

Note:
Most tablets with LCD screen will echo strokes to the integrated LCD even when this flag is set. Kofax is in contact with the tablet manufacturers to add supporting this feature in future versions. Please contact Kofax to check if this feature is supported by your tablet device.
See also:
SPGuiAcquSetDrawMode

#define SP_VPSIGN_PAD   1002
 

Tablet device ID: VPSign.

Identifier for an VPSign device.

See also:
SPTabletGetDevice

#define SP_WINTAB_DRV   1
 

Tablet driver ID: Wintab driver.

Identifier for a Wintab driver.

See also:
SPTabletCreate

#define SPCALLBACK   _cdecl
 

#define SPEXTERN   extern
 

#define SPLINK   __cdecl
 

#define SPXEXPORT   __export
 

#define SPXIMPORT   extern
 


Typedef Documentation

typedef struct SP_WEIGHTED_FRAME_S * pSP_WEIGHTED_FRAME_T
 

A weighted frame.

Weighted frames are used to clean static images. The image is analyzed and broken into smaller rectangles, each rectangle is assigned a weight in the range 0 .. 1.0, a higher weights indicates a probability that the contents of the rectangle belong to a signature stroke.

See also:
SPGuiDispSetWeightedFrames, SPImageGetFrames

typedef struct SDKACQUIRE_S* pSPACQUIRE_T
 

Pointer to an SPAcquire object.

SPAcquire objects capture signature(s) on a tablet without Gui. SPGuiAcqu is similar to SPAcquire but adds a user interface.

See also:
SPAcquire.h, SPAcquireCreate, SPAcquireFree

typedef struct SDKBACKGROUNDOBJECTS_S* pSPBACKGROUNDOBJECTS_T
 

Pointer to an SPBackgroundObjects container.

A SPBackgroundObjects contains:

  • name of the referencing device
  • a set of background objects to compose the entire background image
See also:
SPBackgroundObjects.h, SPBackgroundObjectsCreateFromFile, SPBackgroundObjectsCreateFromXML, SPBackgroundObjectsFree

typedef struct SDKCLEANPARAMETER_S* pSPCLEANPARAMETER_T
 

Pointer to an SPCleanParameter object.

An SPCleanParameter object contains parameters used for cleaning static signatures.

See also:
SPCleanParameter.h, SPCleanParameterCreate, SPCleanParameterFree

typedef struct SDKCOMPARE_S* pSPCOMPARE_T
 

Pointer to an SPCompare object.

A SPCompare object contains:

  • parameters for comparing signatures and reference
  • the result of the comparison
  • the match level achieved by the comparison.
Use the appropriate SPCompareSet and SPCompareGet functions to access the parameters and results.

See also:
SPCompare.h, SPCompareCreate, SPCompareFree

typedef struct SDKGUIACQU_S* pSPGUIACQU_T
 

Pointer to an SPGuiAcqu object.

SPGuiAcqu objects implement the graphical user interface for capturing signatures on a tablet.

See also:
SPGuiAcqu.h, SPGuiAcquCreate, SPGuiAcquFree

typedef struct SDKGUICONTAINER_S* pSPGUICONTAINER_T
 

Pointer to an SPGuiContainer object.

SPGuiContainer objects capture signatures.

See also:
SPGuiContainer.h, SPGuiContainerCreate, SPGuiContainerFree

typedef struct SDKGUIDISP_S* pSPGUIDISP_T
 

Pointer to an SPGuiDisp object.

SPGuiDisp objects display signatures and their static features.

See also:
SPGuiDisp.h, SPGuiDispCreate, SPGuiDispFree

typedef struct SDKGUIDYN_S* pSPGUIDYN_T
 

Pointer to an SPGuiDyn object.

SPGuiDyn objects display the dynamic features of dynamic signatures.

See also:
SPGuiDyn.h, SPGuiDynCreate, SPGuiDynFree

typedef struct SDKIMAGE_S* pSPIMAGE_T
 

Pointer to an SPImage object.

A SPImage object contains a static image. SPImage objects are used for cleaning static signatures.

See also:
SPImage.h, SPImageCreate, SPImageFree

typedef struct SDKPROPERTYMAP_S* pSPPROPERTYMAP_T
 

Pointer to a PropertyMap object.

typedef struct SPRECT_S * pSPRECT_T
 

A rectangle bounding a set of pixels.

The coordinates are absolute screen or image coordinates.

See also:
SPGuiAcquRegisterRect, SPImageRegion, SPImageMaskImage etc
Todo:
Define inclusive/exclusive.

typedef struct SDKREFERENCE_S* pSPREFERENCE_T
 

Pointer to an SPReference object.

A SPReference object is a collection of signature objects forming a signature reference.

Use the appropriate SPReferenceGet functions to access the contents of the object.

See also:
SPReference.h, SPReferenceCreate, SPReferenceCreateFromFlatFile, SPReferenceFree

typedef struct SDKSCANNER_S* pSPSCANNER_T
 

Pointer to a Scanner object.

typedef struct SDKSCANNERENUM_S* pSPSCANNERENUM_T
 

Pointer to a ScannerEnum object.

typedef struct SDKSIGNATURE_S* pSPSIGNATURE_T
 

Pointer to an SPSignature object.

A SPSignature object contains a dynamic signature, ie, biometric data and information about the tablet used for capturing the signature.

Use the appropriate SPSignatureSet and SPSignatureGet functions to access the contents of the object.

See also:
SPSignature.h, SPSignatureCreate, SPSignatureFree

typedef struct SDKSMARTCARD_S* pSPSMARTCARD_T
 

Pointer to an SPSmartCard object.

A SPSmartcard object contains the identifier of the smart card driver and the smart card device.

Use the appropriate SPSmartcardGet functions to access the contents of the object.

See also:
SPSmartcard.h, SPSmartcardCreate, SPSmartcardFree

typedef struct SDKSMARTCARDDRIVER_S* pSPSMARTCARDDRIVER_T
 

Pointer to an SPSmartcardDriver object.

A SPSmartcardDriver object contains the identifier of a smart card driver.

See also:
SPSmartcardDriver.h, SPSmartcardDriverCreateByIndex, SPSmartcardDriverFree

typedef struct SDKTABLET_S* pSPTABLET_T
 

Pointer to an SPTablet object.

A SPTablet object conains the identifier of the tablet, the size and resolution of the tablet, and any registered listeners.

Use the appropriate SPTabletSet and SPTabletGet functions to access the contents of the object.

See also:
SPTablet.h, SPTabletCreate, SPTabletFree

typedef struct SDKTABLETENUM_S* pSPTABLETENUM_T
 

Pointer to an SPTabletEnum object.

A SPTabletEnum object conains the descriptors to all devices for a specific tablet class.

See also:
SPTablet.h, SPTabletEnumCreate, SPTabletEnumFree

typedef struct SDKTELLER_S* pSPTELLER_T
 

Pointer to an SPTeller object.

A SPTeller object interfaces with SignBase®.

See also:
SPTeller.h, SPTellerCreate, SPTellerFree

typedef struct SP_IMAGEDATA_S* pSPTELLERIMAGE_T
 

Pointer to a an SPTellerImage object.

SPTellerImage objects are used to pass images from SignWare to SignBase using the Teller interface.

See also:
SPTeller.h, SPTellerImageCreateFromSignature, SPTellerImageFree

typedef struct SDKTEMPLATE_S* pSPTEMPLATE_T
 

Pointer to an SPTemplate object.

A SPTemplate object is a compressed representation of a signature reference. It is optimized for minimum storage space.

Use the appropriate SPTemplateGet functions to access the contents of the object.

See also:
SPTemplate.h, SPTemplateCreateFromReference, SPTemplateFree

typedef struct SDKTICKET_S* pSPTICKET_T
 

Pointer to an SPTicket object.

SPTickets objects are used in a network license environment. The application must 'buy' tickets from the license server, and pass them to the ticket consumer. The ticket consumer uses the ticket to ask the License Manager if a certain action can be executed with the provided ticket.

Deprecated:
Please use a license key.
See also:
SPTicket.h, SPTicketCreate, SPTicketFree, SP_LICENSEERR

typedef struct SP_WEIGHTED_FRAME_S SP_WEIGHTED_FRAME_T
 

A weighted frame.

Weighted frames are used to clean static images. The image is analyzed and broken into smaller rectangles, each rectangle is assigned a weight in the range 0 .. 1.0, a higher weights indicates a probability that the contents of the rectangle belong to a signature stroke.

See also:
SPGuiDispSetWeightedFrames, SPImageGetFrames

typedef int SPBOOL
 

SPBOOL is a boolean.

typedef char SPCHAR
 

SPCHAR is an 8-bit character.

typedef double SPDOUBLE
 

SPDOUBLE is an IEEE 754 double-precision floating-point number.

typedef float SPFLOAT
 

SPFLOAT is an IEEE 754 single-precision floating-point number.

typedef HWND SPHWND
 

SPHWND is a window handle.

typedef HINSTANCE SPINSTANCE
 

SPINSTANCE is a DLL instance handle.

typedef int SPINT32
 

SPINT32 is a 32-bit signed integer.

typedef HMODULE SPMODULE
 

SPMODULE is a DLL handle (shared library handle).

typedef struct SPRECT_S SPRECT_T
 

A rectangle bounding a set of pixels.

The coordinates are absolute screen or image coordinates.

See also:
SPGuiAcquRegisterRect, SPImageRegion, SPImageMaskImage etc
Todo:
Define inclusive/exclusive.

typedef unsigned char SPUCHAR
 

SPUCHAR is an unsigned 8-bit character (byte).

typedef unsigned int SPUINT32
 

SPUINT32 is a 32-bit unsigned integer.

typedef void* SPVPTR
 

SPVPTR is a void pointer.

The size of a pointer depends on the operating system:

  • 32 Bit operating system: a Pointer is a 32 bit unsigned value
  • 64 Bit operating system: a Pointer is a 64 bit unsigned value

typedef wchar_t SPWCHAR
 

SPWCHAR is a wide character (16 bits for Windows, 32 bits for Linux).


Function Documentation

SPINT32 __cdecl SPAnsiToUnicode const SPCHAR pszAnsi,
SPWCHAR **  ppUnicode
 

Convert an ANSI string to a Unicode string.

This function converts from the current system Windows ANSI codepage.

Parameters:
pszAnsi [i] the null-terminated ANSI string to be converted.
ppUnicode [o] pointer to a variable that will be filled with the address of an array of wide characters containing the null-terminated Unicode encoding of the string pointed to by pszAnsi. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in wide characters) of the Unicode string on success, a negative value on error:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPUnicodeToAnsi, SPAnsiToUtf8

SPINT32 __cdecl SPAnsiToUtf8 const SPCHAR pszAnsi,
SPCHAR **  ppszUtf8
 

Convert an ANSI string to a UTF-8 string.

This function converts from the current system Windows ANSI codepage.

Parameters:
pszAnsi [i] the null-terminated ANSI string to be converted.
ppszUtf8 [o] pointer to a variable that will be filled with the address of an array of characters containing the null-terminated UTF-8 encoding of the string pointed to by pszAnsi. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in bytes) of the UTF-8 string on success, a negative value on error:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPAnsiToUnicode, SPUtf8ToAnsi

SPINT32 __cdecl SPAsciiToUnicode const SPCHAR pszAnsi,
SPWCHAR **  ppUnicode
 

Convert an ANSI string to a Unicode string.

Despite its name, this function converts from the current system Windows ANSI codepage.

Parameters:
pszAnsi [i] the null-terminated ANSI string to be converted.
ppUnicode [o] pointer to a variable that will be filled with the address of an array of wide characters containing the null-terminated Unicode encoding of the string pointed to by pszAnsi. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in wide characters) of the Unicode string on success, a negative value on error:
Deprecated:
This function has been replaced by SPAnsiToUnicode.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPAnsiToUnicode, SPUnicodeToAnsi, SPAnsiToUtf8

SPINT32 __cdecl SPAsciiToUtf8 const SPCHAR pszAnsi,
SPCHAR **  ppszUtf8
 

Convert an ANSI string to a UTF-8 string.

Despite its name, this function converts from the current system Windows ANSI codepage.

Parameters:
pszAnsi [i] the null-terminated ANSI string to be converted.
ppszUtf8 [o] pointer to a variable that will be filled with the address of an array of characters containing the null-terminated UTF-8 encoding of the string pointed to by pszAnsi. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in bytes) of the UTF-8 string on success, a negative value on error:
Deprecated:
This function has been replaced by SPAnsiToUtf8.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPAnsiToUnicode, SPAnsiToUTf8, SPUtf8ToAnsi

SPINT32 __cdecl SPBase64Decode const SPCHAR pszBase64,
SPCHAR **  ppbData,
int *  piDataLen
 

Decode a Base64-encoded string.

Parameters:
pszBase64 [i] pointer to the null-terminated string containing Base64-encoded data.
ppbData [o] pointer to a variable that will be filled with the address of an array of bytes containing the decoded data. The caller is responsible for deallocating the array of characters by calling SPFreeString.
piDataLen [o] pointer to a variable that will be filled with the length (in bytes) of the decoded data.
Returns:
the length (in bytes) of the decoded data on success, a negative value on error:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPBase64Encode

SPINT32 __cdecl SPBase64Encode const SPCHAR pbData,
int  iDataLen,
SPCHAR **  ppszBase64
 

Convert binary data to a Base64-encoded string.

Parameters:
pbData [i] pointer to the data to be converted.
iDataLen [i] the length (in bytes) of the data to be converted.
ppszBase64 [o] pointer to a variable that will be filled with the address of an array of characters containing the null-terminated Base64 encoding of the iDataLen bytes pointed to by pbData. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in bytes) of the Base64 string on success, a negative value on error:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPBase64Decode

SPINT32 __cdecl SPCompress const SPCHAR pSrc,
SPINT32  iSrcLen,
SPCHAR **  ppDest,
SPINT32 piDestLen
 

Compress data.

This function uses ZLIB to compress data.

Parameters:
pSrc [i] pointer to the data to be compressed.
iSrcLen [i] length (in bytes) of the data to be compressed.
ppDest [o] pointer to a variable that will be filled with the address of an array of bytes containing the compressed data. The caller is responsible for deallocating the array of characters by calling SPFreeString.
piDestLen [o] pointer to a variable that will be filled with the length (in bytes) of the compressed data.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPDecompress

SPINT32 __cdecl SPDecompress const SPCHAR pSrc,
SPINT32  iSrcLen,
SPCHAR **  ppDest,
SPINT32 piDestLen
 

Decompress data.

This function uses ZLIB to decompress data.

Parameters:
pSrc [i] pointer to the data to be decompressed.
iSrcLen [i] length (in bytes) of the data to be decompressed.
ppDest [o] pointer to a variable that will be filled with the address of an array of bytes containing the decompressed data. The caller is responsible for deallocating the array of characters by calling SPFreeString.
piDestLen [o] pointer to a variable that will be filled with the length (in bytes) of the compressed data.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPCompress

SPINT32 __cdecl SPFreeMemory SPUCHAR **  ppMemory  ) 
 

Deallocate an array of frames or split positions.

The array must have been allocated by SPImageGetFrames or SPImageGetSplitPositions.

Parameters:
ppMemory [io] pointer to a variable containing a pointer to the array. The variable will be set to NULL if this function succeeds.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPFreeString SPCHAR **  ppData  ) 
 

Deallocate a string or an array of bytes.

The string or array of bytes must have been allocated by SPAnsiToUnicode, SPAnsiToUtf8, SPBase64Decode, SPBase64Encode, SPCleanParameterGetEnableFlag, SPCleanParameterGetString, SPCompress, SPDecompress, SPTicketGetSession, SPUnicodeToAnsi, SPUnicodeToUtf8, SPUtf8ToAnsi, or SPUtf8ToUnicode.

Parameters:
ppData [io] pointer to a variable containing a pointer to a string or array of bytes. The variable will be set to NULL if this function succeeds.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPSignwareCheckLM SPINT32  iAction  ) 
 

Check if a license is available for a certain action.

If the ticket license model is used, you must create and pass a ticket charged for the action to SignWare (see SPSignwareSetTicket) before calling this function.

Parameters:
iAction [i] the license action to check:
Returns:
SP_NOERR for success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignwareSetTicket

SPINT32 __cdecl SPSignwareCloseSession SPINT32  iAction,
const SPCHAR pszSession
 

Inform the License Manager about termination of a session.

This function is reserved for Kofax internal use.

Deprecated:
Please use a license key.
Parameters:
iAction [i] license action (SP_TICKET_LOAD_SIGNWARE etc.).
pszSession [i] session identifier, subsequent calls to SPTicketCharge must use the same session identifier. A session identifier is an arbitrary UTF-8-encoded string identifying uniquely a session.
Returns:
SP_NOERR for success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)

SPINT32 __cdecl SPSignwareDaysLM SPINT32 piNumDays  ) 
 

Get the number of days left until the license expires.

Parameters:
piNumDays [o] pointer to a variable that will be filled with the number of days left until the license expires. Special vales are:
  • -1 license has already expired
  • 0 license will expire today
  • 1 license will expire tomorrow
  • 0x7FFFFFFF license is unlimited (more than 4 years)
Returns:
SP_NOERR for success, else error code.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)

SPINT32 __cdecl SPSignwareGetActualTime SPUINT32 piTime  ) 
 

Get the current time as a signature timestamp.

Parameters:
piTime [o] pointer to a variable that will be filled with the current time in seconds since 1970-01-01 00:00:00 UTC.
Returns:
SP_NOERR on success, else error code:
Deprecated:
Replaced by SPSignwareGetCurrentTime.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignwareGetCurrentTime, SPSignatureGetTimeStamp, SPSignatureSetTimeStamp

SPINT32 __cdecl SPSignwareGetBrowserTicket const SPCHAR pszRequestUrl,
pSPTICKET_T  pTicket,
SPCHAR **  ppszTicket
 

Create a Browser ticket.

Use SPFreeString to free the allocated ppszTicket if you no longer need the ticket.

Note:
The Kofax capture plugin will request a local license if the parameter Auth is omitted. 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.
Parameters:
pszRequestUrl [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
ppszTicket [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
Returns:
int SP_NOERR on success, else error code
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString

SPINT32 __cdecl SPSignwareGetCurrentTime SPUINT32 piTime  ) 
 

Get the current time as a signature timestamp.

Parameters:
piTime [o] pointer to a variable that will be filled with the current time in seconds since 1970-01-01 00:00:00 UTC.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignatureGetTimeStamp, SPSignatureSetTimeStamp

const SPCHAR* __cdecl SPSignwareGetErrorString SPINT32  iErrCode  ) 
 

Convert a SignWare error code to an English text.

This function is used within Kofax, but is not generally available as the returned message is always in English and will not be translated.

The returned string must not be modified. The returned pointer is valid until SPSignwareGetErrorString is called again.

Parameters:
iErrCode [i] an error code that was returned by a SignWare function.
Returns:
pointer to a string containing the error message in English.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
Todo:
Make the return value a const pointer.

SPINT32 __cdecl SPSignwareGetInstallationCode SPCHAR pchInstallationCode,
SPINT32  iLen
 

Query the installation code.

Parameters:
pchInstallationCode [io] pointer to a buffer with a length of at least 25 characters that will be filled with the installation code (zero terminated string)
iLen [i] length of the provided buffer [in bytes]
Returns:
int
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)

SPINT32 __cdecl SPSignwareGetVersionInt SPINT32 piVersion  ) 
 

Get the SignWare version as an integer.

The components of the version number can be extracted this way from the returned value iValue:

  • major version number: ((iVersion >> 28) & 0xf
  • minor version number: ((iVersion >> 20) & 0xff
  • release version number: ((iVersion >> 0) & 0xfff
Parameters:
piVersion [o] pointer to a variable that will be filled with the version number of SignWare.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignwareGetVersionStr, SPSignwareGetVersionStrEx

SPINT32 __cdecl SPSignwareGetVersionStr SPCHAR pszVersion,
SPINT32  iLen
 

Get the SignWare version as a string.

Parameters:
pszVersion [o] pointer to a buffer that will be filled with the version number of SignWare as a string.
iLen [i] size (in bytes) of the buffer pointed to by pszVersion, must be at least 12.
Returns:
SP_NOERR on success, else error code:
See also:
SPSignwareGetVersionInt, SPSignwareGetVersionStrEx

SPINT32 __cdecl SPSignwareGetVersionStrEx SPINT32  iModule,
SPCHAR pszVersion,
SPINT32  iLen
 

Get the version of a SignWare module as a string.

Parameters:
iModule [i] identify the module whose version number is requested:
  • SP_SDK_MODULE get version number of SignWare
  • SP_GRAPHLIB_MODULE get version number of SPFreeImage
pszVersion [o] pointer to a buffer that will be filled with the version number as a string.
iLen [i] size (in bytes) of the buffer pointed to by pszVersion, must be at least 12.
Returns:
SP_NOERR on success, else error code:
  • SP_PARAMERR iModule is invalid, pszVersion is NULL, or iLen is too small
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignwareGetVersionStr, SPSignwareGetVersionInt

SPINT32 __cdecl SPSignwareIsCleanParameter SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPCleanParameter object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPCleanParameter object
  • 1: the object is an SPCleanParameter object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCleanParameter.h

SPINT32 __cdecl SPSignwareIsCompare SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPCompare object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPCompare object
  • 1: the object is an SPCompare object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPCompare.h

SPINT32 __cdecl SPSignwareIsGuiAcqu SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPGuiAcqu object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPGuiAcqu object
  • 1: the object is an SPGuiAcqu object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPGuiAcqu.h

SPINT32 __cdecl SPSignwareIsGuiContainer SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPGuiContainer object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPGuiContainer object
  • 1: the object is an SPGuiContainer object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPGuiContainer.h

SPINT32 __cdecl SPSignwareIsGuiDisp SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPGuiDisp object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPGuiDisp object
  • 1: the object is an SPGuiDisp object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPGuiDisp.h

SPINT32 __cdecl SPSignwareIsGuiDyn SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPGuiDyn object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPGuiDyn object
  • 1: the object is an SPGuiDyn object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPGuiDyn.h

SPINT32 __cdecl SPSignwareIsImage SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPImage object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPImage object
  • 1: the object is an SPImage object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPImage.h

SPINT32 __cdecl SPSignwareIsReference SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPReference object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPReference object
  • 1: the object is an SPReference object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPReference.h

SPINT32 __cdecl SPSignwareIsScanner SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPScanner object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPScanner object
  • 1: the object is an SPScanner object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPScanner.h

SPINT32 __cdecl SPSignwareIsScannerEnum SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPScannerEnum object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPScannerEnum object
  • 1: the object is an SPScanner object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPScanner.h

SPINT32 __cdecl SPSignwareIsSignature SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPSignature object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPSignature object
  • 1: the object is an SPSignature object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPSignature.h

SPINT32 __cdecl SPSignwareIsSmartcard SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPSmartcard object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPSmartcard object
  • 1: the object is an SPSmartcard object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPSmartcard.h

SPINT32 __cdecl SPSignwareIsSmartcardDriver SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPSmartcardDriver object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPSmartcardDriver object
  • 1: the object is an SPSmartcardDriver object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPSmartcardDriver.h

SPINT32 __cdecl SPSignwareIsTablet SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPTablet object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPTablet object
  • 1: the object is an SPTablet object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPTablet.h

SPINT32 __cdecl SPSignwareIsTabletEnum SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPTabletEnum object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPTabletEnum object
  • 1: the object is an SPTabletEnum object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPTablet.h

SPINT32 __cdecl SPSignwareIsTeller SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPTeller object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPTeller object
  • 1: the object is an SPTeller object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPTeller.h

SPINT32 __cdecl SPSignwareIsTemplate SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPTemplate object.

Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPTemplate object
  • 1: the object is an SPTemplate object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPTemplate.h

SPINT32 __cdecl SPSignwareIsTicket SPVPTR  pPtr  ) 
 

Check if a SignWare object is an SPTicket object.

Deprecated:
Please use a license key.
Parameters:
pPtr [i] pointer to a SignWare object.
Returns:
  • 0: the object is not an SPTicket object
  • 1: the object is an SPTicket object
  • SP_INTERR: an error occurred (the object is not a SignWare object)
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPTicket.h

SPINT32 __cdecl SPSignwareNeedTicket SPINT32 piNeeded  ) 
 

Check if tickets are required for the current license model.

Do not call this funcction before you have set the license ID (unless you want to use the default license ID).

Deprecated:
Please use a license key.
Parameters:
piNeeded [o] pointer to a variable that will be set to 0 if tickets are not used or to 1 if tickets are required.
Returns:
SP_NOERR for success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)

SPINT32 __cdecl SPSignwareOpenSession SPINT32  iAction,
const SPCHAR pszSession
 

Inform the License Manager about a new session.

This function is reserved for Kofax internal use.

Deprecated:
Please use a license key.
Parameters:
iAction [i] license action (SP_TICKET_LOAD_SIGNWARE etc.).
pszSession [i] session identifier, subsequent calls to SPTicketCharge must use the same session identifier. A session identifier is an arbitrary UTF-8-encoded string identifying uniquely a session.
Returns:
SP_NOERR for success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)

SPINT32 __cdecl SPSignwareSetLicenseKey const void *  pKey,
SPINT32  iKey,
const char *  pszProduct,
const char *  pszVersion,
const void *  pToken,
SPINT32  iToken
 

Set the 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.

Please contact your Kofax sales representative.

Parameters:
pKey [i] pointer to the first character of the license key.
iKey [i] the size (in bytes) of the license key.
pszProduct [i] Must be NULL.
pszVersion [i] Must be NULL.
pToken [i] NULL or pointer to the first octet of the token. Should be NULL.
iToken [i] the size (in bytes) of the token. Must be 0 if pToken is NULL.
Returns:
SP_NOERR for success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPSignwareSetLM2 SPINT32  iLm2Id_1,
SPINT32  iLm2Id_2
 

Set the license ID.

The license ID tells the License Manager which license file to choose, and to read the allowed licensed actions from that file. Kofax may generate custom license ID's on request. Please contact your Kofax sales representative.

Note:
The standard SignWare license ID is (809213154, 373825325)

The Signware Capture license ID is (1782290325, 766889438). The application must initialize the license manager if it wants to use a SignwareCapture-License.

Deprecated:
Please use SPSignwaresetlicensekey().
Parameters:
iLm2Id_1 [i] first part of license ID.
iLm2Id_2 [i] second part of license ID.
Returns:
SP_NOERR for success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPSignwareSetLicenseKey

SPINT32 __cdecl SPSignwareSetTicket pSPTICKET_T  pTicket  ) 
 

Pass a license ticket.

When using ticket license, you must pass a ticket before you can create any SignWare object (except for SPTicket). This function copies the SPTicket object.

The ticket must be charged for one of these actions:

Deprecated:
Please use a license key.
Parameters:
pTicket [i] pointer to an SPTicket object that has been charged for the desired action.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a)
See also:
SPTicketCreate, SPTicketCharge, SPCompareSetTicket

SPINT32 __cdecl SPSignwareStatus SPINT32 piStatus  ) 
 

Get the status of the SignWare SDK.

Parameters:
piStatus [o] pointer to a variable that will be filled with an integer containing one bit per external library. A bit is set if the corresponding library is loaded.
Returns:
SP_NOERR if successful, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SP_GRAPHICLIB_LOADED

SPINT32 __cdecl SPSignwareViewLM SPHWND  hwndParent  ) 
 

Display a dialog box showing license information.

Parameters:
hwndParent [i] parent window handle.
Returns:
SP_NOERR for success, else error code:
Deprecated:
Replaced by SPSignwareViewLM2, call SPSignwareViewLM2(hwndParent, NULL).
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)
See also:
SPSignwareViewLM2

SPINT32 __cdecl SPSignwareViewLM2 SPHWND  hwndParent,
const char *  pszOptions
 

Display a dialog box showing license information.

The License Viewer is based on Qt. Mixing different Qt versions within the same process can cause problems. Passing the Qt version will cause SignWare to check for compatible Qt versions and disable the dialog box when conflicting versions are encountered.

Parameters:
hwndParent [i] parent window handle.
pszOptions [i] a set of additional string parameters, separated by ';' characters:
  • option1 the language identifier for the dialog:
    • de german
    • en US english (default)
    • uk UK english
  • option2 the Qt version or empty if this is not a Qt application. You can obtain the Qt version by calling qVersion().
    Example: '4.5.3'
Returns:
SP_NOERR for success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM)

SPINT32 __cdecl SPUnicodeToAnsi const SPWCHAR pUnicode,
SPCHAR **  ppszAnsi
 

Convert a Unicode string to an ANSI string.

This function converts to the current system Windows ANSI codepage.

Parameters:
pUnicode [i] the null-terminated Unicode string to be converted.
ppszAnsi [o] pointer to a variable that will be filled with the address of an array of characters containing the null-terminated ANSI encoding of the string pointed to by pUnicode. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in bytes) of the ANSI string on success, a negative value on error:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPAnsiToUnicode, SPUnicodeToUtf8

SPINT32 __cdecl SPUnicodeToAscii const SPWCHAR pUnicode,
SPCHAR **  ppszAnsi
 

Convert a Unicode string to an ANSI string.

Despite its name, this function converts to the current system Windows ANSI codepage.

Parameters:
pUnicode [i] the null-terminated Unicode string to be converted.
ppszAnsi [o] pointer to a variable that will be filled with the address of an array of characters containing the null-terminated ANSI encoding of the string pointed to by pUnicode. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in bytes) of the ANSI string on success, a negative value on error:
Deprecated:
This function has been replaced by SPUnicodeToAnsi.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPAnsiToUnicode, SPUnicodeToAnsi, SPUnicodeToUtf8

SPINT32 __cdecl SPUnicodeToUtf8 const SPWCHAR pUnicode,
SPCHAR **  ppszUtf8
 

Convert a Unicode string to an UTF-8 string.

Parameters:
pUnicode [i] the null-terminated Unicode string to be converted.
ppszUtf8 [o] pointer to a variable that will be filled with the address of an array of characters containing the null-terminated UTF-8 encoding of the string pointed to by pUnicode. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in bytes) of the UTF-8 string on success, a negative value on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPUnicodeToAnsi, SPUtf8ToUnicode

SPINT32 __cdecl SPUtf8ToAnsi const SPCHAR pszUtf8,
SPCHAR **  ppszAnsi
 

Convert a UTF-8 string to an ANSI string.

This function converts to the current system Windows ANSI codepage.

Parameters:
pszUtf8 [i] the null-terminated UTF-8 string to be converted.
ppszAnsi [o] pointer to a variable that will be filled with the address of an array of characters containing the null-terminated ANSI encoding of the string pointed to by pszUtf8. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in bytes) of the ANSI string on success, a negative value on error:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPAnsiToUtf8, SPUtf8ToUnicode

SPINT32 __cdecl SPUtf8ToAscii const SPCHAR pszUtf8,
SPCHAR **  ppszAnsi
 

Convert a UTF-8 string to an ANSI string.

Despite its name, this function converts to the current system Windows ANSI codepage.

Parameters:
pszUtf8 [i] the null-terminated UTF-8 string to be converted.
ppszAnsi [o] pointer to a variable that will be filled with the address of an array of characters containing the null-terminated ANSI encoding of the string pointed to by pszUtf8. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in bytes) of the ANSI string on success, a negative value on error:
Deprecated:
This function has been replaced by SPUtf8ToAnsi.
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPAnsiToUtf8, SPUtf8ToAnsi, SPUtf8ToUnicode

SPINT32 __cdecl SPUtf8ToUnicode const SPCHAR pszUtf8,
SPWCHAR **  ppUnicode
 

Convert a UTF-8 string to a Unicode string.

Parameters:
pszUtf8 [i] the null-terminated UTF-8 string to be converted.
ppUnicode [o] pointer to a variable that will be filled with the address of an array of wide characters containing the null-terminated Unicode encoding of the string pointed to by pszUtf8. The caller is responsible for deallocating the array of characters by calling SPFreeString.
Returns:
the length (in wide characters) of the Unicode string on success, a negative value on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPFreeString, SPUnicodeToUtf8, SPUtf8ToAnsi