pipx40_getMaskState

ViStatus pipx40_getMaskState (ViSession instrumentHandle, ViUInt32 subunitNumber, ViUInt32 channelNumber, ViPBoolean state);

Purpose

Obtains an individual channel's mask setting.

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 whose mask state is to be obtained.
Valid Values:  1 thru the number of outputs available on the
chosen sub-unit

Output
Name Type Description
state ViBoolean (passed by reference)

Variable to receive the chosen channel's mask state.
Values:        VI_OFF = channel unmasked
VI_ON  = channel masked

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