WriteAxisMaxCurrent

Writes the maximum current into an axis.

Syntax

KsError WriteAxisMaxCurrent(
     int Index,
     short Value
);

Parameters

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

Value: the value to write.

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 update the maximum current of an axis.

NOTE:  The maximum current is available only if EnableMaxCurrent is enabled.

Usable EtherCAT states

ecatOP

Example

Copy
nRet = WriteAxisMaxCurrent(0, 10);

Requirements

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

See also

EnableMaxCurrent