_Builder (FB) ¶ FUNCTION_BLOCK FINAL _Builder EXTENDS STR._Disposable IMPLEMENTS IBuilder A Builder is used to efficiently build a string using Write methods. It minimizes memory copying. InOut: Scope Name Type Input Const itfString IString udiInitialCapacity UDINT pbyBuffer POINTER TO BYTE udiBufferSize UDINT usiExtensionFactor USINT Methods: SetInitialValue GetCurrentSegment GetFirstSegment GetNextSegment Len Reset ToIString ValidateSegment WriteIString WriteMemSegment WriteRune WriteString WriteWString Structure: 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)
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)
_Builder.SetInitialValue (METH) ¶ METHOD FINAL SetInitialValue : ERROR InOut: Scope Name Type Initial Return SetInitialValue ERROR Input itfString IString 0 udiInitialCapacity UDINT 0 pbyBuffer POINTER TO BYTE 0 udiBufferSize UDINT 0 usiExtensionFactor USINT 0
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
BlockGetData (FUN) ¶ FUNCTION BlockGetData : PVOID InOut: Scope Name Type Return BlockGetData PVOID Input hBlock HANDLE peError POINTER TO ERROR
BlockGetPool (FUN) ¶ FUNCTION BlockGetPool : HANDLE InOut: Scope Name Type Return BlockGetPool HANDLE Input hBlock HANDLE peError POINTER TO ERROR
PoolCreateH (FUN) ¶ FUNCTION PoolCreateH : HANDLE Take a pool of ctNumBlocks * szBlockSize bytes from the Heap(OS) and build a block pool InOut: Scope Name Type Return PoolCreateH HANDLE Input ctNumBlocks COUNT szBlockSize SIZE peError POINTER TO ERROR
PoolCreateP (FUN) ¶ FUNCTION PoolCreateP : HANDLE Take as much as possible block of szBlockSize bytes from a PLC(IEC) provided memory and build a block pool InOut: Scope Name Type Return PoolCreateP HANDLE Input szBlockSize SIZE szMemSize SIZE pMemory PVOID peError POINTER TO ERROR