GetAxisState

Gets the state of the selected axis.

Syntax

KsError GetAxisState(
     int Index,
     AxisState* State
);

Parameters

Index [in]: the index of an axis. Indexes are zero based. Aliases affect this parameter.

State [out]: pointer to the AxisState type that shows the 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.

Example

Copy

AxisState axisState = AxisState::axisOffline;
KsError nRet = GetAxisState(0, &axisState);

Requirements