UngroupAllAxes

Removes all axes from a group. The command cannot be buffered. After finalization the state is changed to GroupDisabled.

Syntax

KsError UngroupAllAxes(
     int Index
);

Parameters

Index [in]: the index of an axis group. Indexes are zero based. Aliases affect this parameter. You can have up to 32 groups.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

Remarks

If sent to a group that is not in GroupDisabled, GroupStandby, or GroupErrorStop, it generates an error and the function is not executed.

Example

VOID RemoveGroup(INT Group) {
   KsError nRet = UngroupAllAxes(Group);
}

Requirements