Ets_initiatereadbattery() – ETS-Lindgren HI-6153 Electric Field Probe User Manual
Page 131
ETSProbe DLL User Guide
|
131
ETS_I
NITIATE
R
EAD
B
ATTERY
()
int ETS_InitiateReadBattery(const int probeHandle);
Purpose:
Initiates a reading of the battery as a percentage of
full charge. The function returns immediately without
waiting for the operation finish.
To determine when the command is finished, use
ETS_IsOperationComplete. When the reading is
complete, use
ETS_Battery to obtain the value.
Return Value:
Returns an integer status code. The numeric value
0
indicates successful completion.
See Status Codes on page 121 for error code
description.
Input Parameters:
int probeHandle
As returned from
ETS_CreateProbe function.
Output Parameters:
None.
This manual is related to the following products: