VarListDefine (FUN)

FUNCTION VarListDefine : SysTypes.RTS_IEC_HANDLE

Creates a new variable list that will be cyclically updated by the underlying PLCHandler instance. The returned handle must be deleted by calling VarListDelete if no longer in use.

Important

Calling this method might take some time (for registering the list in the connected PLC) so be careful when calling from an IEC-Task. Typically this method should be called in an asynchronous way.

InOut:

Scope

Name

Type

Comment

Return

VarListDefine

SysTypes.RTS_IEC_HANDLE

A handle to the newly created variable list

Input

hPlcHandler

SysTypes.RTS_IEC_HANDLE

The instance to define the variable list on.

ppInstPaths

POINTER TO POINTER TO BYTE

A POINTER to an ARRAY of POINTERs to zero terminated ASCII STRINGs representing the instance paths that should be monitored

numVars

UDINT

The number of variables for the new variable list as pointed to by ppInstPaths

updateRate

UDINT

The update rate for this variable list in milliseconds

Output

result

Error

An error code representing the result of the operation