GetVariableEx

Gets the details of a user-defined variable from a specified folder.

Syntax

KsError GetVariableEx(
     UserVariable* Variable,
     HANDLE Parent
);

Parameters

Variable: the variable you want to get. See the UserVariable structure.

Parent: the parent folder of UserVariable. Input NULL if you want to get variables from the root folder. Use GetVariableEx(&VAR1, DIR.Id) if you want to get variables from a specific folder.

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

The variable can be used in KINGSTAR Scope and a real-time log.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Requirements

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