PIPLX_BattSetEnable

unsigned long PIPLX_BattSetEnable (long session, unsigned long cardNum, unsigned long subunit, unsigned long pattern);

Purpose

Set Battery Simulator (BATT type) channel output enable states

Parameters

Input
Name Type Description
session long

Handle of current session.

cardNum unsigned long

Pickering card reference of target (unity-based)

subunit unsigned long

When SubNum corresponds to a BATT sub-unit, the function sets the output enable state of that sub-unit alone according to the least significant bit of Pattern (0 = OFF, 1 = ON). If SubNum = 0 (BATT_ALL_BATT_SUB_UNITS), enable states of all the card's BATT sub-units are set; bits in the supplied Pattern are utilised in ascending order of BATT sub-unit, i.e.

pattern unsigned long

the pattern of channel outputs to enable ('1' bit enables corresponding channel)

Return Value

Name Type Description
error unsigned long

0 = success; non-zero = error code

References

Battery Simulator
Client Bridge for LXI - Base module
Alphabetical Function Index
Hierarchical Function Index