MotionHoldGateGet()

bool MotionHoldGateGet

(

)

Description:

MotionHoldGateGet returns the state of the Axis' hold gate.

Returns

(bool) True = gate is set, motion will not execute. False = gate is not set, motion will execute.

Remarks

This function is also available in RapidSequencer.

Part of the Motion Configuration method group.

Sample Code:

if (MotionHoldGateGet() == true)
{
  printf(" Motion Hold Gate is set, motion will not execute until cleared.\n");
}

See also

MotionHoldGateSet

Note

By default, an Axis or MultiAxis will use a gate number which matches its number. Keep in mind there are only 32 hold gates, so if your Axis or MultiAxis number is greater than 31, you must adjust using MotionHoldGateNumberSet