IApi.EnableAliases method

Enables the alias indexes for the axis and I/O index parameters in all methods. The alias index should be set first. This allows the application to have a different drive order from the physical EtherCAT link.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsError EnableAliases(
       bool Active
)

Function EnableAliases(
       Active As Boolean
) As KsError

Parameters

Active

Type: bool

This parameter determines whether aliases are used. true to enable, and false to disable aliasing. By default, it is false.

Return value

Type: KsError

A return code of a method.

Remarks

It gets details for each drive and identifies each drive using vendor, product, and alias. If drives are not plugged in the correct order, rearrange the list of drives. Use it after the KINGSTAR Subsystem is started.

Usable EtherCAT states

ecatOP

Examples

N/A