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.
ITextListInfo.Name (PROP) ¶ PROPERTY Name : STRING(255) The name of the TextList
ITextListInfo.Release (METH) ¶ METHOD Release : BOOL Call this method when you do not need the information provided anymore. .. note: The instance can not be used anymore after this method has been called . InOut: Scope Name Type Return Release BOOL
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 26.01.2022, 10:25:14 companyName string 3S-Smart Software Solutions GmbH libraryFile TextListUtils.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile TextListUtils.clean.json version version 2.0.0.0 ProjectInformation IsEndUserLibrary bool True Released True LastModificationDateTime date 26.01.2022, 10:25:14 LibraryCategories library-category-list Intern|Utils Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace TLU Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder TextListUtils Project TextListUtils Title TextListUtils Version version 4.1.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CAA FB Factory ¶ Library Identification ¶ Placeholder: CAA FB Factory Default Resolution: CAA FB Factory, * (CAA Technical Workgroup) Namespace: FBF Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA FB Factory CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Types CmpDynamicText ¶ Library Identification ¶ Placeholder: CmpDynamicText Default Resolution: CmpDynamicText, * (System) Namespace: CmpDynamicText Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpDynamicText CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) Element Collections ¶ Library Identification ¶ Placeholder: ElementCollections Default Resolution: Element Collections, * (3S - Smart Software Solutions GmbH) Namespace: COL Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: ElementCollections StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringUtils