pipx40_getSubAttribute

ViStatus pipx40_getSubAttribute (ViSession instrumentHandle, ViUInt32 subunitNumber, ViBoolean function, ViUInt32 attributeCode, ViPUInt32 attributeValue);

Purpose

Obtains the value of a sub-unit attribute. These values facilitate customized operation of particular sub-unit types using panel "Operate Switch" (function pipx40_operateSwitch).

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.
This function is only applicable to certain sub-unit types (matrix with auto-isolation and/or auto-loopthru features).

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 (unsupported)
1 = Output sub-unit

attributeCode ViUInt32

A code indicating the attribute whose value is to be queried.
Valid codes are:
0x00000001 = pipx40_SUB_ATTR_CHANNEL_SUBSWITCHES
Gets number of subswitches per logical channel
(matrix crosspoint)
0x00000002 = pipx40_SUB_ATTR_X_ISO_SUBSWITCHES
Gets number of subswitches per logical
X-isolator
0x00000003 = pipx40_SUB_ATTR_Y_ISO_SUBSWITCHES
Gets number of subswitches per logical
Y-isolator
0x00000004 = pipx40_SUB_ATTR_X_LOOPTHRU_SUBSWITCHES
Gets number of subswitches per logical
X-loopthru
0x00000005 = pipx40_SUB_ATTR_Y_LOOPTHRU_SUBSWITCHES
Gets number of subswitches per logical
Y-loopthru
0x00000100 = pipx40_SUB_ATTR_NUM_X_SEGMENTS
Gets number of X-axis segments
0x00000101 = pipx40_SUB_ATTR_X_SEGMENT01_SIZE
Gets size of X-axis segment 1
0x00000102 = pipx40_SUB_ATTR_X_SEGMENT02_SIZE
Gets size of X-axis segment 2
0x00000103 = pipx40_SUB_ATTR_X_SEGMENT03_SIZE
Gets size of X-axis segment 3
0x00000104 = pipx40_SUB_ATTR_X_SEGMENT04_SIZE
Gets size of X-axis segment 4
0x00000105 = pipx40_SUB_ATTR_X_SEGMENT05_SIZE
Gets size of X-axis segment 5
0x00000106 = pipx40_SUB_ATTR_X_SEGMENT06_SIZE
Gets size of X-axis segment 6
0x00000107 = pipx40_SUB_ATTR_X_SEGMENT07_SIZE
Gets size of X-axis segment 7
0x00000108 = pipx40_SUB_ATTR_X_SEGMENT08_SIZE
Gets size of X-axis segment 8
0x00000109 = pipx40_SUB_ATTR_X_SEGMENT09_SIZE
Gets size of X-axis segment 9
0x0000010A = pipx40_SUB_ATTR_X_SEGMENT10_SIZE
Gets size of X-axis segment 10
0x0000010B = pipx40_SUB_ATTR_X_SEGMENT11_SIZE
Gets size of X-axis segment 11
0x0000010C = pipx40_SUB_ATTR_X_SEGMENT12_SIZE
Gets size of X-axis segment 12
0x00000200 = pipx40_SUB_ATTR_NUM_Y_SEGMENTS
Gets number of Y-axis segments
0x00000201 = pipx40_SUB_ATTR_Y_SEGMENT01_SIZE
Gets size of y-axis segment 1
0x00000202 = pipx40_SUB_ATTR_Y_SEGMENT02_SIZE
Gets size of y-axis segment 2

Output
Name Type Description
attributeValue ViUInt32 (passed by reference)

Variable to receive the value of the specified attribute.

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