SysDirRename30 (FUN) ¶ FUNCTION SysDirRename30 : UDINT InOut: Scope Name Type Return SysDirRename30 UDINT Input szOldDirName REFERENCE TO STRING szNewDirName REFERENCE TO STRING
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 03.07.2018, 10:34:34 companyName string 3S-Smart Software Solutions GmbH libraryFile SysDir23.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP13 contentFile SysDir23.clean.json version version 2.0.0.0 ProjectInformation Released bool True Support32BitOnly True LastModificationDateTime date 03.07.2018, 10:34:34 LibraryCategories library-category-list System|SysLibs23 Author string 3S - Smart Software Solutions GmbH Company System Description See: Description Project SysDir23 Title SysDir23 Version version 3.5.13.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) SysDir ¶ Library Identification ¶ Placeholder: SysDir Default Resolution: SysDir, * (System) Namespace: SysDir Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysDir SysTypes Interfaces ¶ Library Identification ¶ Name: SysTypes Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes Interfaces, * (System)
SysDirCopy (FUN) ¶ FUNCTION SysDirCopy : RTS_IEC_RESULT Copies the contents of szSourceDir to szDestDir. Nonexisting destination path will be created. Depending of the parameters, all subdirectories and its content will be copied too, and existing files will be overwritten. NOTE: Empty direcories will be copied if xRecursive is TRUE. InOut: Scope Name Type Comment Return SysDirCopy RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors_Itf.library) Input szDestDir REFERENCE TO STRING Name of destination directory szSourceDir REFERENCE TO STRING Name of source directory xRecursive BOOL TRUE: all subdirectories and their contents are copied, FALSE: subdirectories are omitted xOverwrite BOOL TRUE: existing files are overwritten, FALSE: existing files are left untouched
SysDirCreate (FUN) ¶ FUNCTION SysDirCreate : RTS_IEC_RESULT Creates a new directory with the specified name InOut: Scope Name Type Comment Return SysDirCreate RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors_Itf.library) Input szDir REFERENCE TO STRING Name of the directory
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
SysDirCreate2 (FUN) ¶ FUNCTION SysDirCreate2 : RTS_IEC_RESULT Creates a new directory with the specified name. If xRecursive is set, a full path is created, i.e. all missing parent directories are created too. InOut: Scope Name Type Comment Return SysDirCreate2 RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors_Itf.library) Input szDir REFERENCE TO STRING Name of the directory xRecursive BOOL Create a full path
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)