ReadAxisStatusWord

Reads the value of the Statusword variable from an axis.

Syntax

KsError ReadAxisStatusWord(
     int Index,
     WORD* Value
);

Parameters

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

Value: pointer to the buffer to receive the status word.

Return value

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

Usable EtherCAT states

ecatOP

Example

Copy
WORD statusWord = 0;
nRet = ReadAxisStatusWord(0, &statusWord);

Requirements

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

See also

ReadAxisMopDisplay

ReadAxisSecondEncoder

ReadAxisTouchProbeStatus

WriteAxisControlWord