Advanced function reference, Ets_battery() – ETS-Lindgren HI-6153 Electric Field Probe User Manual

Page 124

Advertising
background image


124

|

ETSProbe DLL User Guide

Advanced Function Reference

ETS_B

ATTERY

()

int ETS_Battery(const int probeHandle, int &Batt);

Purpose:

To obtain the battery status as a percentage of full
charge. The

ETS_InitiateReadBattery function must

be called prior to this call. This function returns a fresh
battery reading after each

ETS_InitiateReadBattery

command.

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:

Pass-by-reference integer: The battery value as a
percentage of full charge.

Advertising