pipx40_setCrosspointMask
|
Function |
pipx40_setCrosspointMask (ByVal vi As Long, ByVal subUnit As Long, ByVal row As Long, ByVal column As Long, ByVal state As Boolean) As Long | |
|
ViStatus |
pipx40_setCrosspointMask (ViSession vi, ViUInt32 subUnit, ViUInt32 row, ViUInt32 column, ViBoolean state); |
|
Parameter |
I/O |
Description |
|
vi |
in |
Instrument handle |
|
subUnit |
in |
Numeric variable indicating in which sub-unit actions will take place |
|
row |
in |
Row (Y) location of the crosspoint to be affected |
|
column |
in |
Column (X) location of the crosspoint to be affected |
|
state |
in |
VI_ON to mask, VI_OFF to unmask |
Return Value
0 = Successful operation. Negative values are error codes and positive values are warnings. To get a description of the error, pass the error code to pipx40_error_message.
Description
Mask or unmask a single matrix crosspoint.
Note
This function supports matrix operation using row/column co-ordinates in place of the linearized channel-number method employed by pipx40_setMaskState. It offers more straightforward matrix operation, and avoids the need for re-coding if a matrix card is replaced by one having different dimensions.
Remarks
Masking disables the corresponding crosspoint for the pipx40_setChannelState, pipx40_setCrosspointState and pipx40_setChannelPattern functions. An error is reported by those functions if an attempt is made to activate a masked channel.
This facility is particularly useful to guard against programming errors that could otherwise result in damage to matrix switches or external circuits.