MotionHoldGateGet()

bool MotionHoldGateGet ( )

pure virtual

Get the state of the hold gate.

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.

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