ReadAxisAlias

Reads an alias index from an axis.

Syntax

KsError ReadAxisAlias(
     int Index,
     int* Alias
);

Parameters

Index: the index of an axis. Indexes are zero based.

Alias: pointer to the value to receive the alias index.

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
int aliasRead = 0;
nRet = ReadAxisAlias(0, &aliasRead);

Requirements

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

See also

EnableAliases

GetAliasesStatus

WriteAxisAlias