SysDirDelete (FUN) ¶ FUNCTION SysDirDelete : RTS_IEC_RESULT Deletes a directory with the specified name InOut: Scope Name Type Comment Return SysDirDelete RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors_Itf.library) Input szDir REFERENCE TO STRING Name of directory
SysDirDelete2 (FUN) ¶ FUNCTION SysDirDelete2 : RTS_IEC_RESULT Deletes a directory with the specified name If xRecursive is set, a whole folder tree can be deleted, i.e. all subfolders and files are deleted. If xRecursive and xKeepDir are set, the folder is kept but its contents is deleted. InOut: Scope Name Type Comment Return SysDirDelete2 RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors_Itf.library) Input szDir REFERENCE TO STRING Name of directory xRecursive BOOL Delete a whole folder tree xKeepDir BOOL Keep the starting folder
SysDirGetCurrent (FUN) ¶ FUNCTION SysDirGetCurrent : RTS_IEC_RESULT Get current working directory for IEC file access InOut: Scope Name Type Comment Return SysDirGetCurrent RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors_Itf.library) Inout szDir STRING OUT_PARAMETER: Name of current directory Input diMaxDirLen DINT Max lenght of directory buffer
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)
SysDirRename (FUN) ¶ FUNCTION SysDirRename : RTS_IEC_RESULT Rename directory InOut: Scope Name Type Comment Return SysDirRename RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library) Input szOldDirName REFERENCE TO STRING Name of existing directory szNewDirName REFERENCE TO STRING Name of new directory
SysDirSetCurrent (FUN) ¶ FUNCTION SysDirSetCurrent : RTS_IEC_RESULT Set current working directory on the target. In this directory all following file function are operated. This setting applies to file access from IEC only. An empty string resets the working directory to its default. This function should not be used in parallel to any other file operation from IEC. InOut: Scope Name Type Comment Return SysDirSetCurrent RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library) Input szDir REFERENCE TO STRING Name of current directory
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 16:02:12 companyName string 3S-Smart Software Solutions GmbH libraryFile SysDir.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile SysDir.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 20.04.2021, 16:02:12 LibraryCategories library-category-list System|SysLibs Author string `` 3S - Smart Software Solutions GmbH `` Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description DocFormat reStructuredText Placeholder SysDir Project SysDir Title SysDir Version version 3.5.17.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
SysEventCreate (FUN) ¶ FUNCTION SysEventCreate : DWORD InOut: Scope Name Type Return SysEventCreate DWORD Inout Const stName STRING
