Document Title Here
AET65 API
Version 1.0
idvation GmbH
Otto-Hesse-Straße 19 / T5
Phone +49 6151 9926567
D-64293 Darmstadt
Fax +49 6151 3689296
www.idvation.com
Page 42 of 84
Page 42 of 84
5.2.4.
ABS_OPERATION
Holds common data used by all interactive operation functions.
typedef struct abs_operation {
ABS_DWORD OperationID;
void* Context;
ABS_CALLBACK Callback;
ABS_LONG Timeout;
ABS_DWORD Flags;
} ABS_OPERATION
Description
OperationID
Unique operation ID or zero.
When set to non-zero, the value identifies the operation. You can
then use the ID to cancel the operation with ABSCancel-Operation,
even from other thread. Please note that it’s the caller's
responsibility to assign the IDs so that in the context of one session
no concurrent interactive operation (i.e. in other thread) has the
same value. Otherwise the operation fails immediately with
ABS_STATUS_INVALID_PARAMETER.
If set to zero, you can cancel the operation only from its callback
(passing a zero as the parameter for ABSCancelOperation).
Context
User defined pointer, passed into the operation callback.
BSAPI does not interpret nor dereferences the pointed data in any
way.
Callback
Pointer to application-defined function, implementing operation
callback.
This allows application developers to provide user interface which
informs user how the operation processes and prompts him to do
something, e.g. put his finger on the FM sensor.
See documentation of ABS_CALLBACK for more detailed
information.
Timeout
Timeout of user's inactivity in milliseconds
If the interactive operation expects some user's activity and it's not
detected for the time specified, the operation is interrupted and the
operation function returns ABS_STATUS_TIMEOUT.
Value 0 denotes no timeout (user's inactivity does not cause the
operation to be interrupted). Value -1 denotes to use the default
timeout (device dependent).
Flags
Bitmask of flags, tuning the operation process.
See description of constants ABS_OPERATION_FLAG_xxxx for
more information.
