PIPLX_MaskBit

unsigned long PIPLX_MaskBit (long session, unsigned long cardNumber, unsigned long outputSubunit, unsigned long bitNumber, int action);

Purpose

Mask or unmask a single output bit.
Masking disables the corresponding switch for the PIPLX_OpBit, PIPLX_OpCrosspoint and PIPLX_WriteSub functions. 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. Note that PIPLX_MaskCrosspoint allows more straightforward use of row/column co-ordinates with matrices.

Parameters

Input
Name Type Description
session long

Handle of current session.

cardNumber unsigned long

Card number.

outputSubunit unsigned long

Subunit number.

bitNumber unsigned long

Bit number.

action int

1 to mask, 0 to unmask.

Return Value

Name Type Description
return unsigned long

Zero for success, or no-zero error code.

References

Mask
General purpose output
Client Bridge for LXI - Base module
Alphabetical Function Index
Hierarchical Function Index