SyncDefineVarList (FUN)

FUNCTION SyncDefineVarList : SysTypes.RTS_IEC_HANDLE

Creates a variable list to be used lateron with SyncReadVarListFromPlc or SyncWriteVarListToPlc. The resulting variable list must be released by a followup call to SyncDeleteVarList.

Important

As communication and symbolic resolution is involved, take care (async calls etc.) when using this method from an IEC-Task

InOut:

Scope

Name

Type

Comment

Return

SyncDefineVarList

SysTypes.RTS_IEC_HANDLE

A handle to the newly created variable list

Input

hPlcHandler

SysTypes.RTS_IEC_HANDLE

The instance of the PLCHandler to work 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 written

numSymbols

UDINT

The number of variables to read. In fact this number represents the number of entries in ppInstPaths

flags

VarListFlags

A combination of flag values applying to the newly created variable list

Output

result

Error

An error code representing the result of the operation