IDisposable.ObjectRelease (METH) ¶ METHOD ObjectRelease : ERROR InOut: Scope Name Type Return ObjectRelease ERROR

IDisposable.ObjectRetain (METH) ¶ METHOD ObjectRetain : ERROR InOut: Scope Name Type Return ObjectRetain ERROR

IRange (ITF) ¶ INTERFACE IRange EXTENDS IDisposable Rune by rune Iteration over the content of a string like instance. Methods: GetNextRune Reset UngetLastRune ObjectDispose , inherited from IDisposable ObjectRelease , inherited from IDisposable ObjectRetain , inherited from IDisposable Structure: GetNextRune (Method) Reset (Method) UngetLastRune (Method)

Copy (FUN) ¶ FUNCTION Copy : UDINT Overwrites the content of itfDstString with the content of itfSrcString It returns the number of bytes written. InOut: Scope Name Type Return Copy UDINT Input itfDstString IString itfSrcString IString Output eErrorID ERROR

CreateRangePool (FUN) ¶ FUNCTION CreateRangePool : IRangePool Creates a pool for IRange instances in the specified memory space InOut: Scope Name Type Initial Comment Return CreateRangePool IRangePool Input pbyPool POINTER TO BYTE Pointer to the first byte of the memory. This address should aligned to a __XWORD boundary! udiPoolSize UDINT Size of the allocated memory for the range pool. This size must not be smaller than SIZEOF(_RangePool) , because it includes an instance of _RangePool(FB) usiExtensionFactor USINT 0 Optional extension factor of the IRangePool instance Output eErrorID ERROR

CreateString (FUN) ¶ FUNCTION CreateString : IString Returns a IString instance placed in the memory area given by the parameters. Example for a 80 byte IString instance: udiCapacity : UDINT ; // Capacity of the new String axwMemory : ARRAY [0..(SIZEOF(_UTF8String)+79) / SIZEOF(__XWORD)] OF __XWORD ; itfString : IString := CreateString ( ADR ( axwMemory ), SIZEOF ( axwMemory ), 0 , udiStrSize => udiCapacity ); InOut: Scope Name Type Initial Comment Return CreateString IString Input pbyMemory POINTER TO BYTE Pointer to the first byte of the memory. This address should aligned to a __XWORD boundary! udiMemSize UDINT Size of the allocated memory for the string. This also includes the memory for the _UTF8String instance, so the function block of string instance. If e.g. a 80 byte string is requred than memory size would be SIZEOF(STR._UTF8String) + 80 psValue POINTER TO BYTE 0 optional address of a utf-8 encoded, zero terminated byte array (string), used as inital value Output udiStrSize UDINT The capacity in bytes of the new IString instance eErrorID ERROR

CreateStringPool (FUN) ¶ FUNCTION CreateStringPool : IStringPool Creates a pool for IString instances in the specified memory space The size of the strings is specified via udiStringSize InOut: Scope Name Type Initial Comment Return CreateStringPool IStringPool Input udiStringSize UDINT pbyPool POINTER TO BYTE Pointer to the first byte of the memory. This address should aligned to a __XWORD boundary! udiPoolSize UDINT Size of the allocated memory for the range. This size must not be smaller than SIZEOF(_StringPool) , because it includes an instance of _StringPool(FB) usiExtensionFactor USINT 0 Optional extension factor of the IStringPool instance Output eErrorID ERROR

IsValidString (FUN) ¶ FUNCTION IsValidString : BOOL Reports whether itfString consists entirely of valid UTF-8-encoded runes. InOut: Scope Name Type Return IsValidString BOOL Input itfString IString Output eErrorID ERROR

Len (FUN) ¶ FUNCTION Len : UDINT Returns the number of bytes required for the UTF-8 encoded string segment of ifString . InOut: Scope Name Type Return Len UDINT Input itfString IString Output eErrorID ERROR

Reset (FUN) ¶ FUNCTION Reset : ERROR Set back the empty state of this IString instance InOut: Scope Name Type Return Reset ERROR Input itfString IString