pipx40_getMaskPattern

ViStatus pipx40_getMaskPattern (ViSession instrumentHandle, ViUInt32 subunitNumber, unsigned long pattern[]);

Purpose

Obtains a bit-pattern representation of a sub-unit's switch mask. A '1' bit in the mask indicates that the corresponding channel is disabled for 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

Output
Name Type Description
pattern unsigned long []

Array to receive a bit-pattern representing the switch mask of the chosen output sub-unit.
A '0' bit in the pattern indicates that the corresponding channel is unmasked.
A '1' bit in the pattern indicates that the corresponding channel is masked.
Channel 1 is represented in the least significant bit of the least significant element of the array.
NOTE: the number of 32-bit longwords appropriate to the size of the chosen sub-unit will be overwritten. If the array passed is of insufficient size overspill will occur, causing corruption of adjacent memory.

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