WriteIOAlias

Writes the alias index into a real or simulated I/O module. The alias index allows you to reorder the list of modules if the cabling does not match the program.

Syntax

KsError WriteIOAlias(
     int Index,
     int Alias
);

Parameters

Index: the actual index of an I/O module. Indexes are zero based. Aliases affect this parameter.

Alias: the alias index to use, in place of the index of the I/O module. Indexes are zero based.

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

WriteIOAlias can only be called once a link is established and started.
The alias index can be outside the actual index range of the I/O modules.
Remember to call EnableAliases after enabling the alias indexes for the parameters of axes and I/O modules in all functions.

Usable EtherCAT states

ecatOP

Example

N/A

Requirements

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