MotionHoldGateSet()

void MotionHoldGateSet

(

bool

hold

)

Description:

MotionHoldGateSet sets the state of the Motion Hold Gate.

Parameters

hold	True = gate is set, motion execution will be prevented. false = gate is not set, motion will execute.

Part of the Motion Configuration method group.

Sample Code:

// hold motion (prevent from executing)
axis->MotionHoldGateSet(true);

See also

MotionHoldGateGet

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

Examples

UpdateBufferPoints.cpp.