Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CAA DTUtil Extern ¶ Library Identification ¶ Placeholder: CAA DTUtility Default Resolution: CAA DTUtil Extern, * (CAA Technical Workgroup) Namespace: DTU Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: True SystemLibrary: False Key: CAA DTUtility CAA Real Time Clock Extern ¶ Library Identification ¶ Placeholder: CAA RTCLK Default Resolution: CAA Real Time Clock Extern, * (CAA Technical Workgroup) Namespace: RTCLK Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA RTCLK CAA Tick Extern ¶ Library Identification ¶ Placeholder: CAA Tick Default Resolution: CAA Tick Extern, * (CAA Technical Workgroup) Namespace: TICKS Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: True SystemLibrary: False Key: CAA Tick CAA TickUtil Extern ¶ Library Identification ¶ Placeholder: CAA TickUtil Default Resolution: CAA TickUtil Extern, * (CAA Technical Workgroup) Namespace: TICKU Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: True SystemLibrary: False Key: CAA TickUtil CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: True SystemLibrary: False Key: CAA Types

GetText (FUN) ¶ FUNCTION GetText : ReturnValues This function returns the language specific text of a textlist as STRING. InOut: Scope Name Type Comment Return GetText ReturnValues Possible last error values: ERR_INSUFFICIENT_BUFFER ERR_PARAMETER ERR_FAILED ERR_OK see ReturnValues (ENUM) where possible error reasons are described. Inout Const sTextList STRING The textlist name sTextIndex STRING The textlist id Input psText POINTER TO STRING The buffer where the result text should be returned diSize DINT The size of the parameter psText in byte that the parameter SIZEOF() can be used

TextListUtils ¶ GetText (Function) GetTextListInfo (Function) GetTextW (Function) ReturnValues (Enum) TextListInfo ITextListInfo (Interface) GetIdIterator (Method) Name (Property) NumberOfEntries (Property) Release (Method)

GetTextListInfo (FUN) ¶ FUNCTION GetTextListInfo : ITextListInfo Use this method to retrieve information about a given TextList. .. note: Call :ref:`ITextListInfo.Release()` on returned value when you do not need it anymore. InOut: Scope Name Type Comment Return GetTextListInfo ITextListInfo Information about the given TextList. Will be null if the TextList can not be found or contains no entries. Inout Const stTextListName STRING(255) The name of the textlist to search for

GetTextW (FUN) ¶ FUNCTION GetTextW : ReturnValues This function returns the language specific text of a textlist as WSTRING. To retrieve real unicode strings the parameter “Use Unicode strings” must be activated in the visualization manager. InOut: Scope Name Type Comment Return GetTextW ReturnValues Possible last error values: ERR_INSUFFICIENT_BUFFER ERR_PARAMETER ERR_FAILED ERR_OK see ReturnValues (ENUM) where possible error reasons are described. Inout Const sTextList STRING The textlist name sTextIndex STRING The textlist id Input pwsText POINTER TO WSTRING The buffer where the result text should be returned diSize DINT The size of the parameter pwsText in byte that the parameter SIZEOF() can be used

ReturnValues (ENUM) ¶ TYPE ReturnValues : InOut: Name Initial Comment ERR_OK 16#0 The operation succeeded ERR_FAILED 16#1 The operation failed - no text is returned ERR_PARAMETER 16#2 Wrong parameter - no text is returned ERR_INSUFFICIENT_BUFFER 16#3 Insufficient buffer - the returned text is truncated

TextListInfo ¶ ITextListInfo (Interface) GetIdIterator (Method) Name (Property) NumberOfEntries (Property) Release (Method)

ITextListInfo (ITF) ¶ INTERFACE PUBLIC ITextListInfo EXTENDS __SYSTEM.IQueryInterface This interface provides information about a TextList. Properties: Name NumberOfEntries Methods: GetIdIterator Release Structure: GetIdIterator (Method) Name (Property) NumberOfEntries (Property) Release (Method)

ITextListInfo.GetIdIterator (METH) ¶ METHOD GetIdIterator : COL.IIterator An iterator to provide the possibility to loop over all IDs of the TextList. The order of the IDs might differ to the order in the TextList. Note The returned iterator might be null. InOut: Scope Name Type Return GetIdIterator COL.IIterator

ITextListInfo.NumberOfEntries (PROP) ¶ PROPERTY NumberOfEntries : UDINT The number of the entries of the TextList.