GetGroupState

Gets the state of an axis group according to the active grouped function.

Syntax

KsError GetGroupState(
     int Index,
     GroupState* State
);

Parameters

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

State [out]: pointer to the GroupState type that shows an axis' state.

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 outputs reflect the commanded state of the group.

Example

N/A

Requirements