String Segments Library Documentation ¶ Company CODESYS Title String Segments Version 4.0.0.0 Categories Application|Strings Namespace STR Author CODESYS Development GmbH Placeholder StringSegs Description 1 ¶ Implements a simple interface for managing UTF-8 encoded string segments. Contents: ¶ Library Information GetLibVersion (Function) GetLibVersionNumber (Function) IsLibReleased (Function) Strings Aliases Enums Functionblocks Functions Interfaces Indices and tables ¶ 1 Based on String Segments.library, last modified 21.06.2023, 11:09:11. LibDoc 4.4.0.0-b.27 The content file String Segments.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 21.06.2023, 11:09:12.
ERROR (ENUM) ¶ TYPE ERROR : Attributes: qualified_only InOut: Name Initial NO_ERROR WRONG_ENCODING 2 END_OF_BUFFER WRONG_CONFIGURATION WRONG_PARAMETER WRONG_USAGE INVALID_ENCODING NO_MEMORY POOL_EMPTY ALREADY_INITIALIZED WRONG_OPERATION
Function Blocks ¶ Range (FunctionBlock) IRange GetNextRune (Method) Reset (Method) UngetLastRune (Method) SetInitialValue (Method)
Range (FB) ¶ FUNCTION_BLOCK Range EXTENDS STR._Disposable IMPLEMENTS STR.IRange Rune by rune Iteration over the content of itfBuilder . InOut: Scope Name Type Input Const itfBuilder IBuilder Methods: SetInitialValue GetNextRune Reset UngetLastRune Structure: IRange GetNextRune (Method) Reset (Method) UngetLastRune (Method) SetInitialValue (Method)
IRange ¶ GetNextRune (Method) Reset (Method) UngetLastRune (Method)
Range.SetInitialValue (METH) ¶ METHOD FINAL SetInitialValue : STR.ERROR InOut: Scope Name Type Return SetInitialValue STR.ERROR Input itfBuilder IBuilder
Functions ¶ CreateRange (Function) CreateRangePool (Function)
CreateRange (FUN) ¶ FUNCTION CreateRange : STR.IRange Returns a STR.IRange instance placed in the memory area given by the parameters InOut: Scope Name Type Return CreateRange STR.IRange Input pbyMemory POINTER TO BYTE udiMemSize UDINT Output eErrorID STR.ERROR
CreateRangePool (FUN) ¶ FUNCTION CreateRangePool : STR.IRangePool Creates a pool for |IRange| instances in the specified memory space InOut: Scope Name Type Initial Return CreateRangePool STR.IRangePool Input pbyPool POINTER TO BYTE udiPoolSize UDINT usiExtensionFactor USINT 0 Output eErrorID STR.ERROR
Interfaces ¶ IBuilder (Interface) Reset (Method) Segments GetCurrentSegment (Method) GetFirstSegment (Method) GetNextSegment (Method) ValidateSegment (Method) WriteIString (Method) WriteMemSegment (Method) WriteRune (Method) WriteString (Method) WriteWString (Method) ICharmap (Interface) Decode (Method) Encode (Method)