visit Kofax web site
ACTIVESWLib::ISPGuiAcqu

ACTIVESWLib::ISPGuiAcqu Interface Reference

Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPGuiAcquInterface ISPGuiAcqu.

Capture one or more signatures from a Tablet. SPGuiAcqu objects include a graphical representation to draw the vectors online while they are entered.

Note:
Registered event listeners persistence is bound to the lifetime of the ISPGuiAcqu object, independent of the native object.
Signware also includes an object to capture signatures / references without GUI ISPAcquire, please read the section comparison of SPAcquire and SPGuiAcqu.


Public Member Functions

HRESULT Acquire ([out, retval] long *result)
 start tablet acquiry mode
HRESULT AcquireDone ([in] long iResult,[out, retval] long *result)
 terminate tablet acquiry mode
HRESULT AddBackgroundDocument ([in] BSTR description,[out, retval] long *result)
 Add a background document.
HRESULT AddBackgroundDocumentFlatFile ([in] ISPFlatFile *description,[out, retval] long *result)
 Add a background document.
HRESULT AddBackgroundImage ([in] BSTR description,[out, retval] long *result)
 Add a background image.
HRESULT AddBackgroundImageFlatFile ([in] ISPFlatFile *description,[out, retval] long *result)
 Add a background image.
HRESULT AddBackgroundObject ([in] BSTR description,[out, retval] long *result)
 Add images, (visible) rect and text field(s) that will be displayed in the background image.
HRESULT AddBackgroundObjectFlatFile ([in] ISPFlatFile *description,[out, retval] long *result)
 Add images, (visible) rect and text field(s) that will be displayed in the background image.
HRESULT AddBackgroundText ([in] BSTR description,[out, retval] long *result)
 Add a text field that will be displayed in the background image.
HRESULT AddBackgroundTextFlatFile ([in] ISPFlatFile *description,[out, retval] long *result)
 Add a text field that will be displayed in the background image.
HRESULT ClearEntries ([in] long iFlags,[out, retval] long *result)
 Clear all previously acquired input.
HRESULT Connect ([in] long iDriver,[out, retval] long *result)
 connect to a tablet specified by iDriver
HRESULT ConnectByAlias ([in] BSTR bstrTabletAlias,[out, retval] long *result)
 connect to a tablet by an Alias
HRESULT ConnectByEnum ([in] ISPPropertyMap *spDescriptor,[out, retval] long *result)
 connect to a tablet by an enumeration
HRESULT ConnectEx ([in] BSTR bstrTabletClass,[in] BSTR bstrConfig,[out, retval] long *result)
 connect to a tablet specified by iDriver
HRESULT CreateGuiAcqu ([in] __int64 hwndParent,[out, retval] long *result)
 Create a SPGuiAcqu object (window).
HRESULT CreateGuiAcqu32 ([in] __int32 hwndParent,[out, retval] long *result)
 Create a SPGuiAcqu object (window).
HRESULT CreateInClient ([in] __int64 hwndChild,[in] __int64 hwndParent,[out, retval] long *result)
 Create a SPGuiAcqu object within an existing window.
HRESULT CreateInClient32 ([in] __int32 hwndChild,[in] __int32 hwndParent,[out, retval] long *result)
 Create a SPGuiAcqu object within an existing window.
HRESULT CreateTablet ([in] long iDriver,[out, retval] long *result)
 Create a tablet driver object.
HRESULT CreateTabletByAlias ([in] BSTR bstrTabletAlias,[out, retval] long *result)
 create a tablet by an Alias
HRESULT CreateTabletByEnum ([in] ISPPropertyMap *spDescriptor,[out, retval] long *result)
 create a tablet by an enumeration
HRESULT CreateTabletEx ([in] BSTR bstrTabletClass,[in] BSTR bstrConfig,[out, retval] long *result)
 Create a tablet driver object.
HRESULT Disconnect ([out, retval] long *result)
 disconnect from a tablet
HRESULT GetBackgroundColor ([out] long *piColor,[out, retval] long *result)
 Get the background color of this SPGuiAcqu object.
HRESULT GetBackgroundImage ([in] long iSource,[out] ISPImage **ppImage,[out, retval] long *result)
 Query the background image as it is displayed on the tablet or the PC screen.
HRESULT GetBackgroundText ([in] long iSource,[out] BSTR *pbstrText,[out, retval] long *result)
 Query the background text as it is displayed on the tablet or the PC screen.
HRESULT GetBoolProperty ([in] BSTR bstrName,[out] long *piValue,[out, retval] long *result)
 Query a property.
HRESULT GetBorder ([out] long *piBorder,[out, retval] long *result)
 Get the size of the border in the SPGuiAcqu object [in screen pixel].
HRESULT GetDrawMode ([out] long *piMode,[out, retval] long *result)
 Get the draw mode in the SPGuiAcqu object [in screen pixel].
HRESULT GetForegroundColor ([out] long *piColor,[out, retval] long *result)
 Get the foreground color of this SPGuiAcqu object.
HRESULT GetHwnd ([out] __int64 *pHwnd,[out, retval] long *result)
 get the window handle of the window associated with the SPGuiAcqu object
HRESULT GetHwnd32 ([out] __int32 *pHwnd,[out, retval] long *result)
 get the window handle of the window associated with the SPGuiAcqu object
HRESULT GetHwndRect ([out] RECT *pRect,[out, retval] long *result)
 get the size of the SPGuiAcqu object window
HRESULT GetHwndRectInt ([out] long *piLeft,[out] long *piTop,[out] long *piRight,[out] long *piBottom,[out, retval] long *result)
 get the size of the SPGuiAcqu object window
HRESULT GetIntProperty ([in] BSTR bstrName,[out] long *piValue,[out, retval] long *result)
 Query a property.
HRESULT GetReference ([out] ISPReference **ppReference,[out, retval] long *result)
 Query the reference after a signature or reference signature acquiry.
HRESULT GetSignature ([out] ISPSignature **ppSignature,[out, retval] long *result)
 Query the signature during acquiry mode.
HRESULT GetTablet ([out] ISPTablet **ppTablet,[out, retval] long *result)
 get the associated tablet data structure
HRESULT GetTabletRect ([out] RECT *pRect,[out, retval] long *result)
 get the rectangle of the SPGuiAcqu object tablet window size
HRESULT GetTabletRectInt ([out] long *piLeft,[out] long *piTop,[out] long *piRight,[out] long *piBottom,[out, retval] long *result)
 get the rectangle of the SPGuiAcqu object tablet window size
HRESULT RegisterComponent ([in] __int64 hwndComponent,[out, retval] long *result)
 register a component in acquiry mode
HRESULT RegisterComponent32 ([in] __int32 hwndComponent,[out, retval] long *result)
 register a component in acquiry mode
HRESULT RegisterDocumentRect ([in] long aId,[in] BSTR strVirtualButtonDescription,[out, retval] long *result)
 Register a virtual button in a document.
HRESULT RegisterRect ([in, out] long *id,[in] long left,[in] long top,[in] long right,[in] long bottom,[in] long flags,[in] BSTR name,[out, retval] long *result)
 register a rectangle in acquiry mode
HRESULT RegisterRect2 ([in, out] long *id,[in] BSTR description,[out, retval] long *result)
 register a virtual button in acquiry mode
HRESULT RegisterRect2FlatFile ([in, out] long *id,[in] ISPFlatFile *description,[out, retval] long *result)
 register a virtual button in acquiry mode
HRESULT RemoveBackgroundObjects ([out, retval] long *result)
 Remove all images, (visible) rect and text field(s) from the background image.
HRESULT SetActive ([in] long bActive,[out, retval] long *result)
 Activate / deactivate acquiory mode.
HRESULT SetBackgroundColor ([in] long iColor,[out, retval] long *result)
 Set the background color of this SPGuiAcqu object.
HRESULT SetBackgroundImage ([in] SAFEARRAY(BYTE)*pszImage,[out, retval] long *result)
 Pass a background image.
HRESULT SetBackgroundObjects ([in] ISPBackgroundObjects *pspBackgroundObjects,[out, retval] long *result)
 Set the background object for the current tablet.
HRESULT SetBoolProperty ([in] BSTR bstrName,[in] long iValue,[out, retval] long *result)
 Set a property.
HRESULT SetBorder ([in] long iBorder,[out, retval] long *result)
 Set the size of the border in the SPGuiAcqu object [in screen pixel].
HRESULT SetDocumentContent ([in] long aId,[in] SAFEARRAY(BYTE)*pContent,[in] long aFormat,[out, retval] long *result)
 Set the content of a document.
HRESULT SetDocumentContentFile ([in] long aId,[in] BSTR strFile,[in] long aFormat,[out, retval] long *result)
 Set the content of a document.
HRESULT SetDocumentContentFlatFile ([in] long aId,[in] ISPFlatFile *pContent,[in] long aFormat,[out, retval] long *result)
 Set the content of a document.
HRESULT SetDrawMode ([in] long iDrawMode,[out, retval] long *result)
 Set the draw mode of a SPGuiAcqu object.
HRESULT SetForegroundColor ([in] long iColor,[out, retval] long *result)
 Set the foreground color of this SPGuiAcqu object.
HRESULT SetIntProperty ([in] BSTR bstrName,[in] long iValue,[out, retval] long *result)
 Set a property.
HRESULT SetTicket ([in] ISPTicket *pTicket,[out, retval] long *result)
 Pass charged ticket for a capture operation.
HRESULT SetTimeout ([in] long iTimeout,[out, retval] long *result)
 Set the timeout of an acquiry in a SPGuiAcqu object.
HRESULT UnregisterAllComponents ([out, retval] long *result)
 unregister all components in acquiry mode
HRESULT UnregisterAllRects ([out, retval] long *result)
 unregister all rectangles in acquiry mode
HRESULT UnregisterComponent ([in] __int64 hwndComponent,[out, retval] long *result)
 unregister a component in acquiry mode
HRESULT UnregisterComponent32 ([in] __int32 hwndComponent,[out, retval] long *result)
 unregister a component in acquiry mode
HRESULT UnregisterRect ([in] long id,[out, retval] long *result)
 unregister a rectangle in acquiry mode

Member Function Documentation

HRESULT ACTIVESWLib::ISPGuiAcqu::Acquire (  [out, retval] long *  result  ) 
 

start tablet acquiry mode

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
SPGuiAcquAcquire, AcquireDone
Note:
Acquire mode may be dispatched and activated within the message processing thread (this restriction is required by some toblet drivers, e. g. MS TabletPC). This means that errors that occur while processing the state switch may not be passed to the application.
The application may set a timer to check the state of the tablet object, the state will be SP_TABLET_STATE_ACQUIRE on success

CreateTablet, Connect, Disconnect, Acquire and AcquireDone must all be called from the event dispatch thread

HRESULT ACTIVESWLib::ISPGuiAcqu::AcquireDone (  [in] long  iResult,
[out, retval] long *  result
) 
 

terminate tablet acquiry mode

Parameters:
iResult [i] Command, SPAcquireDone, either SPAcquireDone::SPX_IDOK (add signature to reference), or SPAcquireDone::SPX_IDCANCEL (ignore signature)
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:
Acquire, SPGuiAcquAcquireDone, SPAcquireDone
Note:
CreateTablet, Connect, Disconnect, Acquire and AcquireDone must all be called from the event dispatch thread

HRESULT ACTIVESWLib::ISPGuiAcqu::AddBackgroundDocument (  [in] BSTR  description,
[out, retval] long *  result
) 
 

Add a background document.

Parameters:
description [i] XML description of the document, supported encodings in the XML declaration is UTF-8, sec_XML_Data, sec_DocumentDescriptionDTD
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:
SPAcquireAddBackgroundDocument

HRESULT ACTIVESWLib::ISPGuiAcqu::AddBackgroundDocumentFlatFile (  [in] ISPFlatFile *  description,
[out, retval] long *  result
) 
 

Add a background document.

Parameters:
description [i] XML description of the document embedded in a FlatFile, supported encodings in the XML declaration are ASCII, UTF-8 and ISO-8859-1, sec_XML_Data, sec_DocumentDescriptionDTD
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:
SPAcquireAddBackgroundDocument

HRESULT ACTIVESWLib::ISPGuiAcqu::AddBackgroundImage (  [in] BSTR  description,
[out, retval] long *  result
) 
 

Add a background image.

Parameters:
description [i] XML description of the Image, supported encodings in the XML declaration is UTF-8, sec_XML_Data, sec_ImageDescriptionDTD
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:
SPGuiAcquAddBackgroundImage

HRESULT ACTIVESWLib::ISPGuiAcqu::AddBackgroundImageFlatFile (  [in] ISPFlatFile *  description,
[out, retval] long *  result
) 
 

Add a background image.

Parameters:
description [i] XML description of the Image embedded in a FlatFile, supported encodings in the XML declaration are ASCII, UTF-8 and ISO-8859-1, sec_XML_Data, sec_ImageDescriptionDTD
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:
SPGuiAcquAddBackgroundImage

HRESULT ACTIVESWLib::ISPGuiAcqu::AddBackgroundObject (  [in] BSTR  description,
[out, retval] long *  result
) 
 

Add images, (visible) rect and text field(s) that will be displayed in the background image.

Parameters:
description [i] XML description of the object, supported encodings in the XML declaration is UTF-8, sec_XML_Data, sec_ObjectDescriptionDTD
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:
SPGuiAcquAddBackgroundObject

HRESULT ACTIVESWLib::ISPGuiAcqu::AddBackgroundObjectFlatFile (  [in] ISPFlatFile *  description,
[out, retval] long *  result
) 
 

Add images, (visible) rect and text field(s) that will be displayed in the background image.

Parameters:
description [i] XML description of the object embedded in a FlatFile, supported encodings in the XML declaration are ASCII, UTF-8 and ISO-8859-1, sec_XML_Data, sec_ObjectDescriptionDTD
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:
SPGuiAcquAddBackgroundObject

HRESULT ACTIVESWLib::ISPGuiAcqu::AddBackgroundText (  [in] BSTR  description,
[out, retval] long *  result
) 
 

Add a text field that will be displayed in the background image.

Parameters:
description [i] XML description of the text, supported encodings in the XML declaration is UTF-8, sec_XML_Data, sec_TextDescriptionDTD
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:
SPGuiAcquAddBackgroundText

HRESULT ACTIVESWLib::ISPGuiAcqu::AddBackgroundTextFlatFile (  [in] ISPFlatFile *  description,
[out, retval] long *  result
) 
 

Add a text field that will be displayed in the background image.

Parameters:
description [i] XML description of the text embedded in a FlatFile supported encodings in the XML declaration are ASCII, UTF-8 and ISO-8859-1, sec_XML_Data, sec_TextDescriptionDTD
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:
SPGuiAcquAddBackgroundText

HRESULT ACTIVESWLib::ISPGuiAcqu::ClearEntries (  [in] long  iFlags,
[out, retval] long *  result
) 
 

Clear all previously acquired input.

Parameters:
iFlags [i] reserved parameter, should be set to 0
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:
Acquire, AcquireDone, SPGuiAcquClearEntries

HRESULT ACTIVESWLib::ISPGuiAcqu::Connect (  [in] long  iDriver,
[out, retval] long *  result
) 
 

connect to a tablet specified by iDriver

Please read Tablet creation options

Parameters:
iDriver [i] Driver number, pass SP_UNKNOWN_DRV to use any driver
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:
SPGuiAcquConnect, Disconnect
Note:
CreateTablet, Connect, Disconnect, Acquire and AcquireDone must all be called from the event dispatch thread

HRESULT ACTIVESWLib::ISPGuiAcqu::ConnectByAlias (  [in] BSTR  bstrTabletAlias,
[out, retval] long *  result
) 
 

connect to a tablet by an Alias

Please read Tablet creation options for resolving the alias

Parameters:
bstrTabletAlias [i] alias name of the desired tablet
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:
SPAcquireConnectEx, Disconnect

CreateTabletEx

HRESULT ACTIVESWLib::ISPGuiAcqu::ConnectByEnum (  [in] ISPPropertyMap *  spDescriptor,
[out, retval] long *  result
) 
 

connect to a tablet by an enumeration

Please read Tablet creation options for enumerating tablets

Note:
This function connects with the default tablet if spDescriptor is NULL.
Parameters:
spDescriptor [i] descriptor of the desired tablet
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:
SPGuiAcquConnectByEnum, Disconnect

CreateTabletByEnum

HRESULT ACTIVESWLib::ISPGuiAcqu::ConnectEx (  [in] BSTR  bstrTabletClass,
[in] BSTR  bstrConfig,
[out, retval] long *  result
) 
 

connect to a tablet specified by iDriver

Please read Tablet creation options for a list of supported options

Parameters:
bstrTabletClass [i] class name of Kofax tablet access module.
bstrConfig [i] pass optional configuration data. Configuration data depends on the detected hardware driver, see Installation and configuration of various pads
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:
SPGuiAcquConnectEx, Connect, Disconnect

SPTabletCreateEx

HRESULT ACTIVESWLib::ISPGuiAcqu::CreateGuiAcqu (  [in] __int64  hwndParent,
[out, retval] long *  result
) 
 

Create a SPGuiAcqu object (window).

Parameters:
hwndParent [i] Window handle of the parent window
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The default draw Mode is set to SP_RELEASE_FOCUS | SP_VIRTUAL_BUTTON_CLICK
See also:
SPGuiAcquCreate, SetDrawMode

HRESULT ACTIVESWLib::ISPGuiAcqu::CreateGuiAcqu32 (  [in] __int32  hwndParent,
[out, retval] long *  result
) 
 

Create a SPGuiAcqu object (window).

Note:
This method is exclusively for 32-bit applications, it will return an error (SPX_PARAMERR) in a 64-bit process
Parameters:
hwndParent [i] Window handle of the parent window
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The default draw Mode is set to SP_RELEASE_FOCUS | SP_VIRTUAL_BUTTON_CLICK
See also:
SPGuiAcquCreate, SetDrawMode

HRESULT ACTIVESWLib::ISPGuiAcqu::CreateInClient (  [in] __int64  hwndChild,
[in] __int64  hwndParent,
[out, retval] long *  result
) 
 

Create a SPGuiAcqu object within an existing window.

Parameters:
hwndChild [i] Window handle of the child window that will be subclaessed to provide for the functionality
hwndParent [i] Window handle of the parent window
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The default draw Mode is set to SP_RELEASE_FOCUS | SP_VIRTUAL_BUTTON_CLICK
See also:
SPGuiAcquCreateInClient

HRESULT ACTIVESWLib::ISPGuiAcqu::CreateInClient32 (  [in] __int32  hwndChild,
[in] __int32  hwndParent,
[out, retval] long *  result
) 
 

Create a SPGuiAcqu object within an existing window.

Note:
This method is exclusively for 32-bit applications, it will return an error (SPX_PARAMERR) in a 64-bit process
Parameters:
hwndChild [i] Window handle of the child window that will be subclaessed to provide for the functionality
hwndParent [i] Window handle of the parent window
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The default draw Mode is set to SP_RELEASE_FOCUS | SP_VIRTUAL_BUTTON_CLICK
See also:
SPGuiAcquCreateInClient

HRESULT ACTIVESWLib::ISPGuiAcqu::CreateTablet (  [in] long  iDriver,
[out, retval] long *  result
) 
 

Create a tablet driver object.

Please read Tablet creation options

Parameters:
iDriver [i] Driver number, pass SPX_UNKNOWN_DRV to use any driver
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:
SPGuiAcquCreateTablet
Note:
CreateTablet, Connect, Disconnect, Acquire and AcquireDone must all be called from the event dispatch thread

HRESULT ACTIVESWLib::ISPGuiAcqu::CreateTabletByAlias (  [in] BSTR  bstrTabletAlias,
[out, retval] long *  result
) 
 

create a tablet by an Alias

Please read Tablet creation options for resolving the alias

Parameters:
bstrTabletAlias [i] alias name of the desired tablet
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:
SPAcquireConnectEx, Disconnect

CreateTabletEx

HRESULT ACTIVESWLib::ISPGuiAcqu::CreateTabletByEnum (  [in] ISPPropertyMap *  spDescriptor,
[out, retval] long *  result
) 
 

create a tablet by an enumeration

Please read Tablet creation options for enumerating tablets

Note:
This function creates a default tablet if spDescriptor is NULL.
Parameters:
spDescriptor [i] descriptor of the desired tablet
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:
SPGuiAcquCreateTabletByEnum, Disconnect

ConnectByEnum

HRESULT ACTIVESWLib::ISPGuiAcqu::CreateTabletEx (  [in] BSTR  bstrTabletClass,
[in] BSTR  bstrConfig,
[out, retval] long *  result
) 
 

Create a tablet driver object.

Please read Tablet creation options for a list of supported options

Parameters:
bstrTabletClass [i] class name of Kofax tablet access module.
bstrConfig [i] pass optional configuration data. Configuration data depends on the detected hardware driver, see Installation and configuration of various pads
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:
SPGuiAcquCreate, SPGuiAcquFree, SPGuiAcquCreateTablet

SPTabletCreateEx, ConnectEx

HRESULT ACTIVESWLib::ISPGuiAcqu::Disconnect (  [out, retval] long *  result  ) 
 

disconnect from a tablet

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
Connect, SPGuiAcquDisconnect
Note:
CreateTablet, Connect, Disconnect, Acquire and AcquireDone must all be called from the event dispatch thread

HRESULT ACTIVESWLib::ISPGuiAcqu::GetBackgroundColor (  [out] long *  piColor,
[out, retval] long *  result
) 
 

Get the background color of this SPGuiAcqu object.

Parameters:
piColor [i] a pointer to an SPINT32, that will be filled with the background color
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:
SPGuiAcquGetBackgroundColor, SetBackgroundColor

HRESULT ACTIVESWLib::ISPGuiAcqu::GetBackgroundImage (  [in] long  iSource,
[out] ISPImage **  ppImage,
[out, retval] long *  result
) 
 

Query the background image as it is displayed on the tablet or the PC screen.

Parameters:
iSource [i] select the source of the image
  • 1 PC screen
  • 2 Tablet LCD
ppImage [o] pointer to a ISPImage object pointer that will be filled with the resulting image
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The image will NOT contain any partial or fully entered signature strokes.

HRESULT ACTIVESWLib::ISPGuiAcqu::GetBackgroundText (  [in] long  iSource,
[out] BSTR *  pbstrText,
[out, retval] long *  result
) 
 

Query the background text as it is displayed on the tablet or the PC screen.

Parameters:
iSource [i] select the source of the text
  • 1 PC screen
  • 2 Tablet LCD
pbstrText [o] pointer to a BSTR that will be filled with the resulting text
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The image will NOT contain any partial or fully entered signature strokes.

HRESULT ACTIVESWLib::ISPGuiAcqu::GetBoolProperty (  [in] BSTR  bstrName,
[out] long *  piValue,
[out, retval] long *  result
) 
 

Query a property.

Parameters:
bstrName [i] Name of the property, see SPGuiAcqu Properties
piValue [i] pointer to avariable that will be filled with the value of the property
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::ISPGuiAcqu::GetBorder (  [out] long *  piBorder,
[out, retval] long *  result
) 
 

Get the size of the border in the SPGuiAcqu object [in screen pixel].

Parameters:
piBorder [o] a pointer to a SPINT32, that will be filled with the border size
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
Default Border is 5 pixel
See also:
SetBorder, SPGuiAcquGetBorder

HRESULT ACTIVESWLib::ISPGuiAcqu::GetDrawMode (  [out] long *  piMode,
[out, retval] long *  result
) 
 

Get the draw mode in the SPGuiAcqu object [in screen pixel].

Parameters:
piMode [o] a pointer to a SPINT32, that will be filled with the draw mode
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
Default Border is 5 pixel
See also:
SetDrawMode

SPGuiAcquGetDrawMode

HRESULT ACTIVESWLib::ISPGuiAcqu::GetForegroundColor (  [out] long *  piColor,
[out, retval] long *  result
) 
 

Get the foreground color of this SPGuiAcqu object.

Parameters:
piColor [i] a pointer to an SPINT32, that will be filled with the foreground color
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:
SPGuiAcquGetForegroundColor, SetForegroundColor

HRESULT ACTIVESWLib::ISPGuiAcqu::GetHwnd (  [out] __int64 *  pHwnd,
[out, retval] long *  result
) 
 

get the window handle of the window associated with the SPGuiAcqu object

Parameters:
pHwnd [o] a pointer to a window handle, that will be filled with the window handle of the associated SPGui object
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:
SPGuiAcquGetHwnd

HRESULT ACTIVESWLib::ISPGuiAcqu::GetHwnd32 (  [out] __int32 *  pHwnd,
[out, retval] long *  result
) 
 

get the window handle of the window associated with the SPGuiAcqu object

Note:
This method is exclusively for 32-bit applications, it will return an error (SPX_PARAMERR) in a 64-bit process
Parameters:
pHwnd [o] a pointer to a window handle, that will be filled with the window handle of the associated SPGui object
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:
SPGuiAcquGetHwnd

HRESULT ACTIVESWLib::ISPGuiAcqu::GetHwndRect (  [out] RECT *  pRect,
[out, retval] long *  result
) 
 

get the size of the SPGuiAcqu object window

Parameters:
pRect [o] a pointer to a RECT structure, that will be filled with the window rectangle of the associated SPGui object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The returned rect reflects the size and position of the SPGui window in client coordinates.
See also:
SPGuiAcquGetHwndRect, GetTabletRect

HRESULT ACTIVESWLib::ISPGuiAcqu::GetHwndRectInt (  [out] long *  piLeft,
[out] long *  piTop,
[out] long *  piRight,
[out] long *  piBottom,
[out, retval] long *  result
) 
 

get the size of the SPGuiAcqu object window

Parameters:
piLeft [o] left coordinate of the window rectangle of the associated SPGui object
piTop [o] top coordinate of the window rectangle of the associated SPGui object
piRight [o] right coordinate of the window rectangle of the associated SPGui object
piBottom [o] bottom coordinate of the window rectangle of the associated SPGui object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The returned rect reflects the size and position of the SPGui window in client coordinates.
See also:
SPGuiAcquGetHwndRect, GetTabletRect

HRESULT ACTIVESWLib::ISPGuiAcqu::GetIntProperty (  [in] BSTR  bstrName,
[out] long *  piValue,
[out, retval] long *  result
) 
 

Query a property.

Parameters:
bstrName [i] Name of the property, see SPGuiAcqu Properties
piValue [i] pointer to avariable that will be filled with the value of the property
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::ISPGuiAcqu::GetReference (  [out] ISPReference **  ppReference,
[out, retval] long *  result
) 
 

Query the reference after a signature or reference signature acquiry.

Parameters:
ppReference [o] a pointer to a ISPReference object that will be filled with the reference
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The returned Reference may contain a single signature, in this case a signature was captured, or multiple signatures when a true reference was captured. It is the responsability of the application to convert the reference to a signature, if the returned object includes a single signature.

this is a convenience function which behaves exactly like ISPReference.CreateFromGuiAcqu

HRESULT ACTIVESWLib::ISPGuiAcqu::GetSignature (  [out] ISPSignature **  ppSignature,
[out, retval] long *  result
) 
 

Query the signature during acquiry mode.

Parameters:
ppSignature [o] a pointer to a ISPSignature object that will be filled with the signature
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The returned signature must not contain all captured vectors. This function is provided to check for empty signatures BEFORE accepting the signature (see SPGuiAcquAcquireDone).

No signature object will be returned when not in acquiry mode.

this is a convenience function which behaves exactly like ISPSignature.CreateFromGuiAcqu

HRESULT ACTIVESWLib::ISPGuiAcqu::GetTablet (  [out] ISPTablet **  ppTablet,
[out, retval] long *  result
) 
 

get the associated tablet data structure

Parameters:
ppTablet [o] address of a variable that will receive the pSPTABLET_T data structure.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
SPX_PARAMERR will be returned, if the tablet has not yet been created.
See also:
SPGuiAcquGetTablet

HRESULT ACTIVESWLib::ISPGuiAcqu::GetTabletRect (  [out] RECT *  pRect,
[out, retval] long *  result
) 
 

get the rectangle of the SPGuiAcqu object tablet window size

Parameters:
pRect [o] a pointer to a RECT structure, that will be filled with the tablet window rectangle of the associated SPGui object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The returned rect reflects the size and position of the SPGui tablet window in client coordinates, relative to the SPGuiAcqu window. The tablet window is always smaller than the SPGuiAcqu window, as the zoom is calculated such that the aspect ratio of the tablet hardware is maintained, and the entire tablet will be visible within the SPGuiAcqu window.
See also:
SPGuiAcquGetTabletRect

HRESULT ACTIVESWLib::ISPGuiAcqu::GetTabletRectInt (  [out] long *  piLeft,
[out] long *  piTop,
[out] long *  piRight,
[out] long *  piBottom,
[out, retval] long *  result
) 
 

get the rectangle of the SPGuiAcqu object tablet window size

Parameters:
piLeft [o] left coordinate of the tablet window rectangle of the associated SPGui object
piTop [o] top coordinate of the tablet window rectangle of the associated SPGui object
piRight [o] right coordinate of the tablet window rectangle of the associated SPGui object
piBottom [o] bottom coordinate of the tablet window rectangle of the associated SPGui object
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The returned rect reflects the size and position of the SPGui tablet window in client coordinates, relative to the SPGuiAcqu window. The tablet window is always smaller than the SPGuiAcqu window, as the zoom is calculated such that the aspect ratio of the tablet hardware is maintained, and the entire tablet will be visible within the SPGuiAcqu window.
See also:
SPGuiAcquGetTabletRect

HRESULT ACTIVESWLib::ISPGuiAcqu::RegisterComponent (  [in] __int64  hwndComponent,
[out, retval] long *  result
) 
 

register a component in acquiry mode

Parameters:
hwndComponent [i] the component to be registered
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
SPTablet switches the tablet from pointer mode to pen entry mode during acquiry. A registered component will be notified in pen entry mode, when the pen is pressed above a component.

Pen entry mode is exclusive and will not send any notifications to the application as a pointer movement.

Supported window classes:

  • "button", notification is sent as a BM_CLICK message.
  • other classes, notification is sent as a WM_USER message

It is not useful to register Buttons if the connected Tablet does not send proximity vectors, as the cursor does not follow pen movements, thus you cannot see the cursor position. The alternative is to draw the buttons on the tablet for the specific application as a feedback to the user where the buttons are located.

See also:
Acquire, SPGuiAcquRegisterComponent, UnregisterComponent, UnregisterAllComponents

HRESULT ACTIVESWLib::ISPGuiAcqu::RegisterComponent32 (  [in] __int32  hwndComponent,
[out, retval] long *  result
) 
 

register a component in acquiry mode

Note:
This method is exclusively for 32-bit applications, it will return an error (SPX_PARAMERR) in a 64-bit process
Parameters:
hwndComponent [i] the component to be registered
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
SPTablet switches the tablet from pointer mode to pen entry mode during acquiry. A registered component will be notified in pen entry mode, when the pen is pressed above a component.

Pen entry mode is exclusive and will not send any notifications to the application as a pointer movement.

Supported window classes:

  • "button", notification is sent as a BM_CLICK message.
  • other classes, notification is sent as a WM_USER message

It is not useful to register Buttons if the connected Tablet does not send proximity vectors, as the cursor does not follow pen movements, thus you cannot see the cursor position. The alternative is to draw the buttons on the tablet for the specific application as a feedback to the user where the buttons are located.

See also:
Acquire, SPGuiAcquRegisterComponent, UnregisterComponent, UnregisterAllComponents

HRESULT ACTIVESWLib::ISPGuiAcqu::RegisterDocumentRect (  [in] long  aId,
[in] BSTR  strVirtualButtonDescription,
[out, retval] long *  result
) 
 

Register a virtual button in a document.

Note:
The virtual button description includes an id which may not be 0. The button id should be a unique id for each button. Subsequent registrations of virtual buttons with the same id will modify the already registered virtual button, e. g. set an icon, or move the button.
Parameters:
aId [i] unique identifyer of the document
strVirtualButtonDescription [i] description of the rectangle position, size, text, font etc. Please see element SPSWVirtualButton in sec_VirtualButtonDescriptionDTD for details
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:
SetDocumentContent, SetDocumentContentFile, SPGuiAcquRegisterDocumentRect

HRESULT ACTIVESWLib::ISPGuiAcqu::RegisterRect (  [in, out] long *  id,
[in] long  left,
[in] long  top,
[in] long  right,
[in] long  bottom,
[in] long  flags,
[in] BSTR  name,
[out, retval] long *  result
) 
 

register a rectangle in acquiry mode

Parameters:
id [io] the id of the rect to be registered or updated. The variable will be filled with the created ID.
  • If the content of id is 0 then a new virtual button will be created. id will reflect the actual Id that was assigned to the button.
  • If the content of id is not 0 and a virtual button with the same Id is already registered then the existing virtual button will be updated with the passed descriptor
  • If the content of pid is not 0 and a virtual button with the same Id is not yet registered then a new virtual button will be created. The content of pId will be used as the Id for the new virtual button.
left [i] The left coordinate of the rectangle, coordinate transformation depends on flags
top [i] The top coordinate of the rectangle, coordinate transformation depends on flags
right [i] The right coordinate of the rectangle, coordinate transformation depends on flags
bottom [i] The bottom coordinate of the rectangle, coordinate transformation depends on flags
flags [i] A set of optional flags
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
name [i] name of the rect
errors:
Returns:
automation result
Note:
SPTablet switches the tablet from pointer mode to pen entry mode during acquiry. A registered component will be notified in pen entry mode, when the pen is pressed above a rectangle.

Pen entry mode is exclusive and will not send any notifications to the application as a pointer movement.

See also:
Acquire, SPGuiAcquRegisterRect
Deprecated:
Use ACTIVESWLib::ISPGuiAcqu::RegisterRect2

HRESULT ACTIVESWLib::ISPGuiAcqu::RegisterRect2 (  [in, out] long *  id,
[in] BSTR  description,
[out, retval] long *  result
) 
 

register a virtual button in acquiry mode

Parameters:
id [io] the id of the button to be registered or updated. The variable will be filled with the created ID.
  • If the content of id is 0 then a new virtual button will be created. id will reflect the actual Id that was assigned to the button.
  • If the content of id is not 0 and a virtual button with the same Id is already registered then the existing virtual button will be updated with the passed descriptor
  • If the content of pid is not 0 and a virtual button with the same Id is not yet registered then a new virtual button will be created. The content of pId will be used as the Id for the new virtual button.
description [i] XML description of the virtual button, supported encodings in the XML declaration is UTF-8, sec_XML_Data, sec_VirtualButtonDescriptionDTD
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
SPTablet switches the tablet from pointer mode to pen entry mode during acquiry. A registered component will be notified in pen entry mode, when the pen is pressed above a rectangle.

Pen entry mode is exclusive and will not send any notifications to any other applications as a pointer movement.

See also:
SPGuiAcquRegisterRect2

HRESULT ACTIVESWLib::ISPGuiAcqu::RegisterRect2FlatFile (  [in, out] long *  id,
[in] ISPFlatFile *  description,
[out, retval] long *  result
) 
 

register a virtual button in acquiry mode

Parameters:
id [io] the id of the button to be registered or updated. The variable will be filled with the created ID.
  • If the content of id is 0 then a new virtual button will be created. id will reflect the actual Id that was assigned to the button.
  • If the content of id is not 0 and a virtual button with the same Id is already registered then the existing virtual button will be updated with the passed descriptor
  • If the content of pid is not 0 and a virtual button with the same Id is not yet registered then a new virtual button will be created. The content of pId will be used as the Id for the new virtual button.
description [i] XML description of the virtual button embedded in a FlatFile, supported encodings in the XML declaration are ASCII, UTF-8 and ISO-8859-1, sec_XML_Data, sec_VirtualButtonDescriptionDTD
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
SPTablet switches the tablet from pointer mode to pen entry mode during acquiry. A registered component will be notified in pen entry mode, when the pen is pressed above a rectangle.

Pen entry mode is exclusive and will not send any notifications to any other applications as a pointer movement.

See also:
SPGuiAcquRegisterRect2

HRESULT ACTIVESWLib::ISPGuiAcqu::RemoveBackgroundObjects (  [out, retval] long *  result  ) 
 

Remove all images, (visible) rect and text field(s) from the background image.

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

HRESULT ACTIVESWLib::ISPGuiAcqu::SetActive (  [in] long  bActive,
[out, retval] long *  result
) 
 

Activate / deactivate acquiory mode.

Parameters:
bActive [i] activate if not equal 0, else deactivate
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:
SPGuiacquSetActive

HRESULT ACTIVESWLib::ISPGuiAcqu::SetBackgroundColor (  [in] long  iColor,
[out, retval] long *  result
) 
 

Set the background color of this SPGuiAcqu object.

Parameters:
iColor [i] the background color, format 0xrrggbb bb = blue, gg = green, rr = red, each color in range 0 .. 0xff
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:
SPGuiAcquSetBackgroundColor, GetBackgroundColor

HRESULT ACTIVESWLib::ISPGuiAcqu::SetBackgroundImage (  [in] SAFEARRAY(BYTE)*  pszImage,
[out, retval] long *  result
) 
 

Pass a background image.

Parameters:
pszImage,: [i] byte array with one dimension and arbitrary length
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:
SPGuiAcquSetBackgroundImage
Deprecated:
Use ACTIVESWLib::ISPGuiAcqu::AddBackgroundImage

HRESULT ACTIVESWLib::ISPGuiAcqu::SetBackgroundObjects (  [in] ISPBackgroundObjects *  pspBackgroundObjects,
[out, retval] long *  result
) 
 

Set the background object for the current tablet.

Parameters:
pspBackgroundObjects [i] valid instance of ISPBackgroundObjects
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:
SPGuiAcquSetBackgroundObjects

HRESULT ACTIVESWLib::ISPGuiAcqu::SetBoolProperty (  [in] BSTR  bstrName,
[in] long  iValue,
[out, retval] long *  result
) 
 

Set a property.

Parameters:
bstrName [i] Name of the property, see SPGuiAcqu Properties
iValue [i] the value of the property
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::ISPGuiAcqu::SetBorder (  [in] long  iBorder,
[out, retval] long *  result
) 
 

Set the size of the border in the SPGuiAcqu object [in screen pixel].

Parameters:
iBorder [i] the new border size
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
Default Border is 5 pixel
See also:
GetBorder, SPSuiAcquSetBorder

HRESULT ACTIVESWLib::ISPGuiAcqu::SetDocumentContent (  [in] long  aId,
[in] SAFEARRAY(BYTE)*  pContent,
[in] long  aFormat,
[out, retval] long *  result
) 
 

Set the content of a document.

Parameters:
aId [i] unique identifyer of the document
pContent [i] content of the document
aFormat [i] always 2 to specify a data in memory
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:
SPAcquireSetDocumentContent

HRESULT ACTIVESWLib::ISPGuiAcqu::SetDocumentContentFile (  [in] long  aId,
[in] BSTR  strFile,
[in] long  aFormat,
[out, retval] long *  result
) 
 

Set the content of a document.

Parameters:
aId [i] unique identifyer of the document
strFile [i] File name of the document
aFormat [i] always 1 to specify a local file
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:
SPAcquireSetDocumentContent

HRESULT ACTIVESWLib::ISPGuiAcqu::SetDocumentContentFlatFile (  [in] long  aId,
[in] ISPFlatFile *  pContent,
[in] long  aFormat,
[out, retval] long *  result
) 
 

Set the content of a document.

Parameters:
aId [i] unique identifyer of the document
pContent [i] content of the document embedded in a FlatFile
aFormat [i] always 2 to specify a data in memory
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:
SPAcquireSetDocumentContent

HRESULT ACTIVESWLib::ISPGuiAcqu::SetDrawMode (  [in] long  iDrawMode,
[out, retval] long *  result
) 
 

Set the draw mode of a SPGuiAcqu object.

Parameters:
iDrawMode [i] drawing mode
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The tablet area may be smaller than the window area, because the entry will be zoomed to maintain the aspect ratio. The aspect ratio is set to confirm with the tablet hardware.

SP_RELEASE_FOCUS is implemented by subclassing the parent window. The subclassing is released when acquiry mode is stopped.
SP_RELEASE_FOCUS calls SPTabletAcquireDone( SPGuiAcquGetTablet (pSpGui)) when loosing focus, and SPTabletAcquire(SPGuiAcquGetTablet (pSpGui), SPGuiAcquGetHwnd (pSpGui)) when gaining focus.

See also:
SPGuiAcquSetDrawMode, GetHwnd

HRESULT ACTIVESWLib::ISPGuiAcqu::SetForegroundColor (  [in] long  iColor,
[out, retval] long *  result
) 
 

Set the foreground color of this SPGuiAcqu object.

Parameters:
iColor [i] the foreground color, format 0xrrggbb bb = blue, gg = green, rr = red, each color in range 0 .. 0xff
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:
SPGuiAcquSetForegroundColor, GetForegroundColor

HRESULT ACTIVESWLib::ISPGuiAcqu::SetIntProperty (  [in] BSTR  bstrName,
[in] long  iValue,
[out, retval] long *  result
) 
 

Set a property.

Parameters:
bstrName [i] Name of the property, see SPGuiAcqu Properties
iValue [i] the value of the property
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::ISPGuiAcqu::SetTicket (  [in] ISPTicket *  pTicket,
[out, retval] long *  result
) 
 

Pass charged ticket for a capture operation.

Deprecated:
Please use a license key.
Note:
The ticket must be charged for SP_TICKET_CAPTURE
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::ISPGuiAcqu::SetTimeout (  [in] long  iTimeout,
[out, retval] long *  result
) 
 

Set the timeout of an acquiry in a SPGuiAcqu object.

Parameters:
iTimeout [i] timeout [in msec] or 0 to disable timeout checking
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:
SPGuiAcquSetTimeout

HRESULT ACTIVESWLib::ISPGuiAcqu::UnregisterAllComponents (  [out, retval] long *  result  ) 
 

unregister all components in acquiry mode

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
Acquire, RegisterComponent, SPGuiAcquUnregisterAllComponents

HRESULT ACTIVESWLib::ISPGuiAcqu::UnregisterAllRects (  [out, retval] long *  result  ) 
 

unregister all rectangles in acquiry mode

Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
See also:
Acquire, RegisterComponent, SPGuiAcquUnregisterComponent

HRESULT ACTIVESWLib::ISPGuiAcqu::UnregisterComponent (  [in] __int64  hwndComponent,
[out, retval] long *  result
) 
 

unregister a component in acquiry mode

Parameters:
hwndComponent [i] the component to be unregistered
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:
Acquire, SPGuiAcquUnregisterComponent, UnregisterAllComponents

HRESULT ACTIVESWLib::ISPGuiAcqu::UnregisterComponent32 (  [in] __int32  hwndComponent,
[out, retval] long *  result
) 
 

unregister a component in acquiry mode

Note:
This method is exclusively for 32-bit applications, it will return an error (SPX_PARAMERR) in a 64-bit process
Parameters:
hwndComponent [i] the component to be unregistered
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:
Acquire, SPGuiAcquUnregisterComponent, UnregisterAllComponents

HRESULT ACTIVESWLib::ISPGuiAcqu::UnregisterRect (  [in] long  id,
[out, retval] long *  result
) 
 

unregister a rectangle in acquiry mode

Parameters:
id [i] identifier for the the rectangle to be unregistered
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:
Acquire, RegisterComponent, SPGuiAcquUnregisterRect

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