pipx40_getSubInfo

ViStatus pipx40_getSubInfo (ViSession instrumentHandle, ViUInt32 subunitNumber, ViBoolean function, ViPUInt32 subunitType, ViPUInt32 rows, ViPUInt32 columns);

Purpose

Obtains type and dimensional information for one of a card's sub-units (in numeric format).
Note: for programmable attenuator and power supply sub-units more specific information can be obtained using pipx40_attenGetInfo and pipx40_psuGetInfo respectively.

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:  1 thru the number of sub-units of the
specified type (input/output) available on the
card

function ViBoolean

Determines if the sub-unit for which information is to be obtained has Input or Output function.
Valid Values:  0 or 1
0 = Input sub-unit
1 = Output sub-unit

Output
Name Type Description
subunitType ViUInt32 (passed by reference)

Variable to receive the numeric type code of the chosen sub-unit.
Output sub-unit type codes:
1 = pipx40_TYPE_SW     Uncommitted switches
2 = pipx40_TYPE_MUX    Relay multiplexer
(single-channel only)
3 = pipx40_TYPE_MUXM   Relay multiplexer
(multi-channel capable)
4 = pipx40_TYPE_MAT    Standard matrix
5 = pipx40_TYPE_MATR   RF matrix
6 = pipx40_TYPE_DIG    Digital outputs
7 = pipx40_TYPE_RES    Programmable Resistor
8 = pipx40_TYPE_ATTEN  Programmable Attenuator
9 = pipx40_TYPE_PSUDC  Power Supply, DC
Input sub-units always return the value 1.

rows ViUInt32 (passed by reference)

Variable to receive the row-size (Y-dimension) of the chosen sub-unit.
For all types other than matrices, the value of this result is 1.

columns ViUInt32 (passed by reference)

Variable to receive the column-size (X-dimension) of the chosen sub-unit.
For sub-units other than matrices this value contains the significant dimension.

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

ID & Status
Pickering Interfaces PXI VISA
Alphabetical Function Index
Hierarchical Function Index