Scanobject - Socket ScanAPI Reference Manual

Socket ScanAPI Reference

10 ScanObject

The ScanObject is the main object that is exchanged between the application and
ScanAPI.
This object has two main members: Message and Property.
Only the Property is relevant when the application is sending a property to a
ScanAPI object or a Device object.
The Message member is relevant only when the application is receiving a ScanObject
from ScanAPI. The Property member is only relevant if the Message ID received is a
Get Complete or a Set Complete.
A Message has a message identifier field, a result field, a device field, and an event
field.
The identifier field indicates the type of message received. It can be one of the
following:
Name
kSktScanMsgIdDeviceArrival
kSktScanMsgIdDeviceRemoval
kSktScanMsgIdTerminate
kSktScanMsgSetComplete
kSktScanMsgGetComplete
kSktScanMsgEvent
© 2013 Socket Mobile, Inc.
Description
Indicates a new device has arrived and is ready to
be used. The Device field contains the
information about that device.
Indicates a device is no longer available through
ScanAPI. The only possible operation is the Close
API with the device reference. The Device field
contains the information about that device
including the GUID and the device reference if the
device is still open by the application.
Indicates ScanAPI is ready for shutdown. All the
devices have been removed and closed by the
application. It is safe for the application to close
ScanAPI object after releasing the last ScanObject.
Indicates when a Set API operation is completed.
The result of this operation can be retrieved in
the Result field of the Message. The ScanObject
property field contains the property information.
Indicates when a Get API operation is completed.
The result of this operation can be retrieved in
the Result field of the message. The ScanObject
property field contains the property information.
An asynchronous event has been received.
62/152