pipx40_setMaskPattern

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

Purpose

Sets a sub-unit's switch mask to the supplied bit-pattern.
A '1' bit in the mask disables the corresponding channel 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
pattern	unsigned long []	Array containing the mask pattern to be set for the chosen sub-unit. A '0' bit in the pattern unmasks the corresponding channel. A '1' bit in the pattern masks the corresponding channel. Channel 1 is represented in the least significant bit of the least significant element of the array. NOTE: the number of least significant bits appropriate to the size of the chosen sub-unit will be used. If the array passed contains insufficient bits, spurious data will be written to higher bits.

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