pipx40_battGetCurrent

ViStatus pipx40_battGetCurrent (ViSession instrumentHandle, ViUInt32 subunitNumber, ViPReal64 current);

Purpose

Get battery simulator output sink current.

Parameters

Input
Name Type Description
instrumentHandle ViSession

Instrument handle obtained by the pipx40_init call used to open the card.

subunitNumber ViUInt32

The number of the sub-unit to access.
Valid Values:  must correspond to a power supply sub-unit
of the chosen card

Output
Name Type Description
current ViReal64 (passed by reference)

The channel's present sink current setting.

Return Value

Name Type Description
status ViStatus

A numeric code indicating the success or failure of the operation.
VI_SUCCESS = Successful operation.
Negative values are error codes and positive values are warnings.
To get a description of an error, pass the error code to pipx40_error_message.

References

Battery Simulator
Pickering Interfaces PXI VISA
Alphabetical Function Index
Hierarchical Function Index