Introduction To Properties - Socket ScanAPI Reference Manual

Socket ScanAPI Reference
Event Data Type: kSktScanEventDataTypeNone.

12 Introduction to Properties

The Property is a member of a ScanObject. There are used by an application to
retrieve or modify a scanner property by using the Get or Set API respectively.
Each of these operations is completed only upon reception of the Get Complete or
Set Complete events, which also contains the resulting property.
Properties are defined with a property identifier, a value type and a value.
A property contains a Context that is a user parameter field that can be associated to
the property. If an application is using this Context field during a Get or a Set
property operation, the matching Get Complete or Set Complete property received
will return the same Context value.
Once a Set or Get operation is successful the result will always be delivered in the
corresponding Set Complete or Get Complete event. The Msg structure of the
ScanObject received by the application contains the identifier for a Set Complete
message or a Get Complete message and the Result field indicates the success of the
Set or Get operation.
If for some reason the device cannot respond to a Set or Get property operation, that
operation will eventually time out (about 5s), and a Set or a Get complete with a
timeout error in the Msg Result field will be received by the application.
Each property defined in the next chapter accepts different data type for a Get
Operation or a Set Operation.
The data type has to be set accordingly prior performing the operation.
Here is the how this table is defined for each property:
Get
<data type>:
defines the
expected type for a
get operation.
© 2013 Socket Mobile, Inc.
Get Complete
<data type>:
defines the type
received in the get
complete
operation.
Set
<data type>:
defines the
expected type for a
set operation
Set Complete
<data type>:
defines the type
received in the set
complete
operation.
69/152