GetAxisFollowingError

Gets the following error from an axis.

Syntax

KsError GetAxisFollowingError(
     int Index,
     McSource Source,
     double* Error
);

Parameters

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

Source: selects a following error value to read. See the McSource type.

Error: pointer to the current position's following error value to be written.

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

double followingErr = 0.0;
KsError nRet = GetAxisFollowingError(0, McSource:: mcActualValue, &followingErr); // Only supports mcActualValue and mcSecondEncoderValue

Requirements

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