unsigned long PIPLX_BattSetCurrent (long session, unsigned long cardNum, unsigned long subunit, double current);
Set Battery Simulator (BATT type) channel sink current
| Input | ||
| Name | Type | Description |
| session | long |
Handle of current session. |
| cardNum | unsigned long |
Pickering card reference of target (unity-based) |
| subunit | unsigned long |
When Subunit corresponds to a BATT sub-unit, the function sets the sink current of that sub-unit alone.If Subunit = 0 (BATT_ALL_BATT_SUB_UNITS), all of the card's BATT sub-units are set to the given current. |
| current | double |
the current to set (in Amps) |
| Name | Type | Description |
| error | unsigned long |
0 = success; non-zero = error code |
Battery Simulator
Client Bridge for LXI - Base module
Alphabetical Function Index
Hierarchical Function Index