PIPLX_BattGetEnable

unsigned long PIPLX_BattGetEnable (long session, unsigned long cardNum, unsigned long subunit, unsigned long *pattern);

Purpose

Get 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

sub-unit of target to access (unity-based)

Output
Name Type Description
pattern unsigned long (passed by reference)

variable to receive the pattern of channel outputs currently enabled ('1' bit indicates corresponding channel is enabled)

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