GetGroupConfiguration

Gets the index of an axis according to the given group index to read the current configuration of an axis group. For Axes Coordinate System, you get a conventional index of an axis.

Syntax

KsError GetGroupConfiguration(
     int Index,
     int IndexInGroup,
     McCoordSystem CoordSystem,
     int* AxisIndex
);

Parameters

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

IndexInGroup [in]: the index of an axis in the group.

CoordSystem [in]: a coordinate system. See the McCoordSystem type.

AxisIndex [out]: the selected axis in the group.

Return value

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

Example

N/A

Requirements

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