pipx40_setMaskState
|
Function |
pipx40_setMaskState (ByVal vi As Long, ByVal subUnit As Long, ByVal channel As Long, ByVal state As Boolean) As Long | |
|
ViStatus |
pipx40_setMaskState (ViSession vi, ViUInt32 subUnit, ViUInt32 channel, ViBoolean state); |
|
Parameter |
I/O |
Description |
|
vi |
in |
Instrument handle |
|
subUnit |
in |
Numeric variable indicating in which sub-unit actions will take place |
|
channel |
in |
Channel 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 output channel.
Remarks
Masking disables the corresponding channel 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 for matrix sub-units, where it can be used to guard against programming errors that could otherwise result in damage to matrix switches or external circuits.
Certain single-channel multiplexer (MUX type) sub-units have a default channel (that is, a channel that is connected when the sub-unit is in a 'cleared' state). This channel cannot be masked, and an error is given if an attempt is made to mask it.