ReadAxisActualCurrent

Reads the variable (#x6078) of actual current.

Syntax

KsError ReadAxisActualCurrent(
     int Index,
     short* Value
);

Parameters

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

Value: pointer to the buffer to write the actual current.

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

Used in the cyclic callback to check the actual current of an axis.

NOTE:  Actual current is available only if EnableActualCurrent is enabled.

Usable EtherCAT states

ecatOP

Example

Copy
short actualCurrentRead = 0;
nRet = ReadAxisActualCurrent(0, &actualCurrentRead);

Requirements

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

See also

EnableActualCurrent

ReadAxisActualPosition

ReadAxisActualTorque

ReadAxisActualVelocity