File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 03.07.2018, 10:34:55 companyName string 3S-Smart Software Solutions GmbH libraryFile SysInt23.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP13 contentFile SysInt23.clean.json version version 2.0.0.0 ProjectInformation Released bool True Support32BitOnly True LastModificationDateTime date 03.07.2018, 10:34:55 LibraryCategories library-category-list System|SysLibs23 Author string 3S - Smart Software Solutions GmbH Company System Description See: Description Project SysInt23 Title SysInt23 Version version 3.5.13.0
SysMem Library Documentation ¶ Company System Title SysMem Version 3.5.17.0 Categories System|SysLibs Namespace SysMem Author 3S - Smart Software Solutions GmbH Placeholder SysMem Description 1 ¶ This library provides access to the dynamic memory management of the runtim system. Contents: ¶ SysMemAllocData (Function) SysMemCmp (Function) SysMemCpy (Function) SysMemForceSwap (Function) SysMemFreeData (Function) SysMemGetCurrentHeapSize (Function) SysMemIsValidPointer (Function) SysMemMove (Function) SysMemReallocData (Function) SysMemSet (Function) SysMemSwap (Function) Indices and tables ¶ 1 Based on SysMem.library, last modified 20.04.2021, 16:04:25. LibDoc 4.4.0.0-b.27 The content file SysMem.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 16:04:25.
SysMemAllocData (FUN) ¶ FUNCTION SysMemAllocData : POINTER TO BYTE Allocates data memory of the specified size RETURN: Pointer to the memory block. 0 if no memory is not available InOut: Scope Name Type Comment Return SysMemAllocData POINTER TO BYTE Input szComponent STRING Can be the library- or POU-name from IEC udiSize __XWORD Requested size of the memory block pResult POINTER TO RTS_IEC_RESULT Pointer to runtime system error code (see CmpErrors_Itfs.library)
SysMemCmp (FUN) ¶ FUNCTION SysMemCmp : DINT Compares the content of two buffers RETURN: Returns 0 if the buffer contents are equal, else !=0 InOut: Scope Name Type Comment Return SysMemCmp DINT Input pBuffer1 POINTER TO BYTE Address of first memory area (buffer 1) pBuffer2 POINTER TO BYTE Address of second memory area (buffer 2) udiCount __XWORD Number of bytes to be compared
SysMemCpy (FUN) ¶ FUNCTION SysMemCpy : POINTER TO BYTE Copy the content from source (pSrc) to destination buffer (pDest) RETURN: Pointer to the destination buffer, where the copy was done InOut: Scope Name Type Comment Return SysMemCpy POINTER TO BYTE Input pDest POINTER TO BYTE Pointer to memory address to be copied to (target) pSrc POINTER TO BYTE Pointer to memory address to be copied from (source) udiCount __XWORD Number of bytes to be copied
SysMemForceSwap (FUN) ¶ FUNCTION SysMemForceSwap : DINT Routine to force swapping memory independant of the byteorder of the system! RETURN: Number of bytes swapped: -1 = failed (size too large) >0 = Number of bytes swapped InOut: Scope Name Type Comment Return SysMemForceSwap DINT Input pbyBuffer POINTER TO BYTE POINTER TO data TO swap. You can check, which order is selected by calling the routine with pbyBuffer=0 udiSize UDINT Size of one element to swap udiCount UDINT Number of elements to swap
SysMemFreeData (FUN) ¶ FUNCTION SysMemFreeData : RTS_IEC_RESULT Release data memory RETURN: Returns the runtime system error code (see CmpErrors_Itfs.library) InOut: Scope Name Type Comment Return SysMemFreeData RTS_IEC_RESULT Input szComponent STRING Name of the component. Can be the library- or POU-name from IEC. pMemory POINTER TO BYTE Pointer to memory to be released
SysMemGetCurrentHeapSize (FUN) ¶ FUNCTION SysMemGetCurrentHeapSize : __XWORD Routine to get total size of the currently allocated heap memory RETURN: Size of the memory in bytes that is currently allocated from the heap InOut: Scope Name Type Comment Return SysMemGetCurrentHeapSize __XWORD Input pResult POINTER TO RTS_IEC_RESULT Pointer to runtime system error code (see CmpErrors_Itfs.library)
SysMemIsValidPointer (FUN) ¶ FUNCTION SysMemIsValidPointer : RTS_IEC_RESULT Check if a pointer points to a valid address RETURN: Returns the runtime system error code (see CmpErrors_Itfs.library): ERR_OK: Memory is valid ERR_FAILED: Memory is invalid. Cannot be accessed with the requested access mode bWrite InOut: Scope Name Type Comment Return SysMemIsValidPointer RTS_IEC_RESULT Input ptr POINTER TO BYTE Pointer to the memory to be checked udiSize __XWORD Size of the memory to be checked bWrite BOOL TRUE=Check, if memory can be written, FALSE=Check only for read access
SysMemMove (FUN) ¶ FUNCTION SysMemMove : POINTER TO BYTE Copy the content from source (pSrc) to destination buffer (pDest). This routine works for overlapping buffers too in opposite to SysMemCpy! RETURN: Pointer to the destination buffer, where the move was done InOut: Scope Name Type Comment Return SysMemMove POINTER TO BYTE Input pDest POINTER TO BYTE Pointer to memory address to be moved to (target) pSrc POINTER TO BYTE Pointer to memory address to be moved from (source) udiCount __XWORD Number of bytes to be moveed