DisableGroup

Changes the state of a group to GroupDisabled. If the axes are not standby still while sending this command, it is up to the application to take the necessary precautions.

Syntax

KsError DisableGroup(
     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

The command doesn't influence the power state of any single axe in the group.

Example

VOID GroupDisable(INT Group) {
   KsError nRet = DisableGroup(Group);
}

Requirements

	RT	Win32
Minimum supported version	4.0	4.0
Header	ksmotion.h	ksmotion.h
Library	KsApi_Rtss.lib	KsApi.lib