_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
_Builder.WriteString (METH) ¶ METHOD FINAL WriteString : UDINT Appends the contents of sValue to the buffer. It returns the number of bytes written. InOut: Scope Name Type Initial Comment Return WriteString UDINT Inout Const sValue STRING(255) String instance to be written in the builder Input itfCharmap ICharmap 0 Default: Windows-1252 Output eErrorID ERROR Check error message for better diagnostics
_Builder.WriteWString (METH) ¶ METHOD FINAL WriteWString : UDINT Appends the contents of wsValue to the buffer. It returns the number of bytes written. InOut: Scope Name Type Comment Return WriteWString UDINT Inout Const wsValue WSTRING(255) Encoding UCS-2 Output eErrorID ERROR Check error message for better diagnostics
RUNE (ALIAS) ¶ TYPE RUNE : UTF8.|dRUNE| The term rune appears in the libraries and source code, and means exactly the same as “unicode code point”, with one interesting addition. This library defines the word rune as an alias for the type DINT , so programs can be clear when an integer value represents a code point. Moreover, what you might think of as a character constant is called a rune constant. The type and value of the expression WSTRING#"⌘" is a rune with the integer value DINT#16#2318 .
Function Blocks ¶ _Builder (FunctionBlock) IBuilder Reset (Method) Segments GetCurrentSegment (Method) GetFirstSegment (Method) GetNextSegment (Method) ValidateSegment (Method) WriteIString (Method) WriteMemSegment (Method) WriteRune (Method) WriteString (Method) WriteWString (Method) IStringRepresentation Len (Method) ToIString (Method) SetInitialValue (Method)
