UserLimit.ConditionCapture
The capture number used for the CaptureState condition type.
Version History
Introduced in MPX 2.0.
Type
Int32
Index
|
Index Type |
Description |
Int32 |
The index of the condition that is being accessed. Valid index values include 0 and 1. |
|
Common Exceptions
|
Error |
Occurs when... |
UserLimitCannotConfigure |
Attempting to set ConditionCapture and the user limit is not in a ‘being configured’ state.
To resolve the problem, call UserLimit.ConfigurationBegin to begin configuring the user limit.
|
|
Visual Basic
Syntax
Property ConditionCapture As Int32(index As Int32)
Sample Code
|
Dim userLimit As Mpx.UserLimit = controller.Axis(0).UserLimit(0)
userLimit.ConfigurationReset() ' Reset user limit configuration before configuring it
userLimit.ConfigurationBegin() ' Begin configuration
' Configure user limit
userLimit.TriggerType = Mpx.UserLimitTrigger.SingleCondition userLimit.ConditionType(0) = Mpx.UserLimitConditionType.CaptureState userLimit.ConditionAxis(0) = controller.Axis[0].Number userLimit.ConditionActiveHigh(0) = False userLimit.ConditionCapture(0) = 0
userLimit.GenerateEvent = True
userLimit.Action = Mpx.Action.None
userLimit.ConfigurationEnd() ' Writes configuration to the controller
|
Sample Application
C#
Syntax
int[] ConditionCapture;
Sample Code
|
Mpx.UserLimit userLimit = controller.Axis[0].UserLimit[0];
userLimit.ConfigurationReset(); // Reset user limit configuration before configuring it
userLimit.ConfigurationBegin(); // Begin configuration
// Configure user limit
userLimit.TriggerType = Mpx.UserLimitTrigger.SingleCondition; userLimit.ConditionType[0] = Mpx.UserLimitConditionType.CaptureState; userLimit.ConditionAxis[0] = controller.Axis[0].Number; userLimit.ConditionActiveHigh[0] = false; userLimit.ConditionCapture[0] = 0;
userLimit.GenerateEvent = true;
userLimit.Action = Mpx.Action.None;
userLimit.ConfigurationEnd(); // Writes configuration to the controller
|
See Also
ConditionAxis
ConditionActiveHigh
ConditionType
Enumerations
UserLimitConditionType
|