SysDirOpen (FUN) ¶ FUNCTION SysDirOpen : RTS_IEC_HANDLE Opens a specified directory and returns a handle and the first directory entry. szDirEntry is expected to provide enough space to write the direcory entry to. In case szDirEntry is 0, the first directory entry may be retrieved with SysDirRead. InOut: Scope Name Type Comment Return SysDirOpen RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library) Input szDir REFERENCE TO STRING Name of directory. Note Empty string (‘’) is the request for the current working directory. szDirEntry REFERENCE TO STRING OUT_PARAMETER, optional: Directory entry as string, may be 0 diMaxDirEntry DINT OUT_PARAMETER, optional: Max number of bytes to write in pszDirEntry pDirInfo POINTER TO DirInfo OUT_PARAMETER, optional: Directory information, may be 0 pResult POINTER TO RTS_IEC_RESULT OUT_PARAMETER: Pointer to runtime system error code (see CmpErrors.library)
SysDirRead (FUN) ¶ FUNCTION SysDirRead : RTS_IEC_RESULT Read next directory entry. Writes the entry in pszDirEntry. InOut: Scope Name Type Comment Return SysDirRead RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library) ERR_OK: Entry could be read ERR_END_OF_OBJECT: If end of directory list was reached ERR_PARAMETER: If one of the parameters is invalid ERR_BUFFERSIZE: If iMaxDirEntry is too short to get the complete directory entry string Note Typically after error ERR_BUFFERSIZE , the dir-handle is set to the next entry, so this entry will be missed! Input hDir RTS_IEC_HANDLE Handle to directory opened with SysDirOpen Inout szDirEntry STRING OUT_PARAMETER: Directory entry as string Input diMaxDirEntry DINT OUT_PARAMETER: Max number of bytes to write in pszDirEntry pDirInfo POINTER TO DirInfo OUT_PARAMETER: Directory information NOTE: Can be 0 (so only directory name is provided in pszDirEntry)
SysSem Interfaces Library Documentation ¶ Company System Title SysSem Interfaces Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ Library provides access to operating system semaphores on the runtime system for data synchronization. ATTENTION: Be aware, that a hangup could occur, if your task will be suspended because of a watchdog error in your protected code! Contents: ¶ GVL (GVL) Indices and tables ¶ 1 Based on SysSem_Itfs.library, last modified 20.04.2021, 16:07:43. LibDoc 4.4.0.0-b.27 The content file SysSem_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 16:07:43.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 16:07:43 companyName string 3S-Smart Software Solutions GmbH libraryFile SysSem_Itfs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile SysSem_Itfs.clean.json version version 2.0.0.0 ProjectInformation IsInterfaceLibrary bool True Released True SourceLibrary False LastModificationDateTime date 20.04.2021, 16:07:43 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 3 DefaultNamespace Description See: Description DocFormat reStructuredText Project SysSem_Itfs Title SysSem Interfaces Version version 3.5.17.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces.
SysShm Implementation Library Documentation ¶ Company System Title SysShm Implementation Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Placeholder SysShm Implementation Description 1 ¶ Library to get access to a shared memory on the target. Contents: ¶ SysSharedMemoryClose (Function) SysSharedMemoryCreate (Function) SysSharedMemoryDelete (Function) SysSharedMemoryGetPointer (Function) SysSharedMemoryOpen2 (Function) SysSharedMemoryRead (Function) SysSharedMemoryReadByte (Function) SysSharedMemoryWrite (Function) SysSharedMemoryWriteByte (Function) Indices and tables ¶ 1 Based on SysShm Implementation.library, last modified 20.04.2021, 16:08:07. LibDoc 4.4.0.0-b.27 The content file SysShm Implementation.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 16:08:07.
SysSharedMemoryClose (FUN) ¶ FUNCTION SysSharedMemoryClose : RTS_IEC_RESULT Close a shared memory object specified by handle. RETURN: Returns the runtime system error code (see CmpErrors_Itfs.library): InOut: Scope Name Type Comment Return SysSharedMemoryClose RTS_IEC_RESULT Input hShm RTS_IEC_HANDLE Handle to the shared memory
SysSharedMemoryCreate (FUN) ¶ FUNCTION SysSharedMemoryCreate : RTS_IEC_HANDLE Create a new shared memory object specified by name. NOTE: If the shared memory object still exists, a valid handle is returned, but with the error code ERR_DUPLICATE. RETURN: Handle to the shared memory object or RTS_INVALID_HANDLE if failed InOut: Scope Name Type Comment Return SysSharedMemoryCreate RTS_IEC_HANDLE Inout Const pszName STRING Name of the shared memory Input ulPhysicalAddress __UXINT Optional physical address. pulSize POINTER TO __UXINT Pointer to requested size of the shared memory. pResult POINTER TO RTS_IEC_RESULT Pointer to runtime system error code (see CmpErrors.library):
SysSharedMemoryDelete (FUN) ¶ FUNCTION SysSharedMemoryDelete : RTS_IEC_RESULT Delete a shared memory object specified by handle RETURN: Returns the runtime system error code (see CmpErrors.library) InOut: Scope Name Type Comment Return SysSharedMemoryDelete RTS_IEC_RESULT Input hShm RTS_IEC_HANDLE Handle to the shared memory
