GetAliasesStatus

Checks whether the program has enabled aliasing through EnableAliases.

Syntax

KsError GetAliasesStatus(
     BOOL* Active
);

Parameters

Active: pointer to a value that returns the state of aliasing. TRUE means aliasing is enabled. FALSE means aliasing is disabled.

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

Use it after the KINGSTAR Subsystem is started.

Usable EtherCAT states

ecatOP

Example

Copy

BOOL aliasStatus = FALSE;
nRet = GetAliasesStatus(&aliasStatus);

Requirements