Scanapi Object Properties; Property Ksktscanpropidabort - Socket ScanAPI Reference Manual

Socket ScanAPI Reference
The following table summarizes what the data type could be and what its definition
is.
Type
Not applicable
None
Byte
Ulong
Array
String
Version
Symbology
Object
There are two sets of properties; the first set applies to a ScanAPI object and the
second set applies to a Device object.
An error (ESKT_INVALIDHANDLE) is returned if a property is applied to a wrong
object. A wrong object would be a ScanAPI object when the property works only for
a Device object or vice versa.
An error (ESKT_INVALIDOPERATION) is returned if a property operation is not
applicable.
An error (ESKT_INVALIDPARAMETER) is returned if a property operation is used
with an incorrect property data type.

13 ScanAPI object properties

13.1 Property kSktScanPropIdAbort

This property is used to start the shutdown process of ScanAPI. This property must
be used in order to proceed to a clean shutdown. Once this property is set, a set
complete message should be received followed by a series of Device Removals if
there are any devices connected to the host. If their matching Device objects have
been opened by the application, they should be closed using the Close API. Once all
the Device objects have been close or if no device handle has been previously
opened, a Terminate message is received. Upon reception of this last message, it is
safe to stop the ScanAPI consumer logic that uses the Wait API, release this last
© 2013 Socket Mobile, Inc.
Definition
The current property does not support this operation.
The current property does not have any data attached for this
operation.
The current property has a byte as data. A byte is an 8-bit
value.
The current property has an unsigned long as data. An
unsigned long is a 32 bit value.
The current property has an array of bytes as data. The array
has a size field denoting the number of bytes in the array.
The current property has a UTF8 character string as data. The
string has a length field and is terminated with a NULL
character. The length does not include the NULL character.
The current property has a Version structure as data.
The current property has a Symbology structure as data.
The current property holds a reference to an object. The
object definition depends on the Property.
70/152