File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 21.06.2023, 11:07:56 companyName string 3S-Smart Software Solutions GmbH libraryFile String Builder.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile String Builder.clean.json version version 2.0.0.0 ProjectInformation AutoResolveUnbound bool True Released True LastModificationDateTime date 21.06.2023, 11:07:54 LibraryCategories library-category-list Application|Strings Author string CODESYS Development GmbH Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Patch 3 DefaultNamespace SBD Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only LibDocContent DocsOnly Placeholder StringBuilder Project String Builder Title String Builder UnitTestingDefine BuilderTesting Version version 4.0.0.0

Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. Immutable String Segments ¶ Library Identification ¶ Placeholder: StringSegs Default Resolution: Immutable String Segments, * (CODESYS) Namespace: STR Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringSegs Memory Block Manager ¶ Library Identification ¶ Placeholder: MemoryBlockManager Default Resolution: Memory Block Manager, * (3S - Smart Software Solutions GmbH) Namespace: MBM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: MemoryBlockManager String Builder Base ¶ Library Identification ¶ Placeholder: StringBuilderBase Default Resolution: String Builder Base, * (CODESYS) Namespace: SBB Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: StringBuilderBase String Conversions ¶ Library Identification ¶ Placeholder: StrConv Default Resolution: String Conversions, * (CODESYS) Namespace: SCV Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: StrConv SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem UTF-16 Encoding Support ¶ Library Identification ¶ Placeholder: UTF16 Default Resolution: UTF-16 Encoding Support, * (CODESYS) Namespace: UTF16 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: UTF16 UTF-8 Encoding Support ¶ Library Identification ¶ Placeholder: UTF8 Default Resolution: UTF-8 Encoding Support, * (CODESYS) Namespace: UTF8 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: UTF8

_Builder.Reset (METH) ¶ METHOD FINAL Reset Resets the Builder to be empty InOut: Scope Name Type Comment Output eErrorID ERROR Check error message for better diagnostics

_Builder.GetCurrentSegment (METH) ¶ METHOD GetCurrentSegment : ERROR Returns the available memory of the free segment Check error return value for better diagnostics InOut: Scope Name Type Comment Return GetCurrentSegment ERROR Output pbyData POINTER TO BYTE Pointer to the first byte of the free segment udiSize UDINT Data size of the free segment

_Builder.GetFirstSegment (METH) ¶ METHOD FINAL GetFirstSegment : POINTER TO BYTE Returns the pointer to the first segment of the builder InOut: Scope Name Type Comment Return GetFirstSegment POINTER TO BYTE Output udiSize UDINT Size of the first segment in bytes eErrorID ERROR Check error message for better diagnostics

_Builder.GetNextSegment (METH) ¶ METHOD FINAL GetNextSegment : POINTER TO BYTE Returns the pointer to the next segment of the builder InOut: Scope Name Type Comment Return GetNextSegment POINTER TO BYTE Input pbyCurSegment POINTER TO BYTE Start pointer of the current segment Output udiSize UDINT Size in bytes of the next segment eErrorID ERROR Check error message for better diagnostics

_Builder.ValidateSegment (METH) ¶ METHOD ValidateSegment : ERROR This method validates the current segment of the builder To get a free segment out of the builder, method GetCurrentSegment can be called beforehand Check error return value for better diagnostics InOut: Scope Name Type Comment Return ValidateSegment ERROR Input pbyData POINTER TO BYTE Pointer to the first byte of the segment udiSize UDINT Size of the first segment Output udiCount UDINT The amount of validated bytes in builder

_Builder.WriteIString (METH) ¶ METHOD FINAL WriteIString : UDINT Appends the contents of itfString to the buffer. It returns the number of bytes written. InOut: Scope Name Type Comment Return WriteIString UDINT Input itfString IStringRepresentation IString to be written Output eErrorID ERROR Check error message for better diagnostics

_Builder.WriteMemSegment (METH) ¶ METHOD FINAL WriteMemSegment : UDINT Writes the memory to one or more segments in the buffer. It returns the number of bytes written. InOut: Scope Name Type Initial Comment Return WriteMemSegment UDINT Input pbyMemory POINTER TO BYTE Entry pointer for memory udiSize UDINT Size of memory in byte eEncoding ENCODING ENCODING.UTF8 Encoding type Output eErrorID ERROR Check error message for better diagnostics

_Builder.WriteRune (METH) ¶ METHOD FINAL WriteRune : UDINT Appends the UTF-8 encoding of Unicode code point diRune to the buffer. It returns the number of bytes written. InOut: Scope Name Type Comment Return WriteRune UDINT Input diRune RUNE Rune to be written Output eErrorID ERROR Check error message for better diagnostics