pipx40_setMaskState

ViStatus pipx40_setMaskState (ViSession instrumentHandle, ViUInt32 subunitNumber, ViUInt32 channelNumber, ViBoolean action);

Purpose

Allows an individual channel to be masked or unmasked. When masked, a channel cannot be activated by the functions pipx40_setChannelState, pipx40_setCrosspointState and pipx40_setChannelPattern.

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 output sub-units
available on the chosen card

channelNumber ViUInt32

The number of the individual output channel of the chosen sub-unit to be masked/unmasked.
Valid Values:  1 thru the number of outputs available on the
chosen sub-unit

action ViBoolean

Determines if the chosen output is to be masked or unmasked.
Valid Values:  0 or 1
0 = Unmask the output
1 = Mask the output

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

Specialised Switching
Pickering Interfaces PXI VISA
Alphabetical Function Index
Hierarchical Function Index