ACCESS_MODE (ENUM) ¶ TYPE ACCESS_MODE : Access mode File modes to open a file. Note For all *_PLUS modes be aware, that after reading from a file, writing can only be done after a call to SysFileGetPos or SysFileSetPos ! If you call SysFileWrite right after SysFileRead , the file pointer could be on an invalid position! Correct example: SysFileRead (); SysFileGetPos (); SysFileWrite (); InOut: Name Comment AM_READ Open an existing file with Read access. If file does not exist, Open fails AM_WRITE Create new file with Write access. If file does exist, content is discarded AM_APPEND Open an existing file with Append (only write) access. If file does not exist, Open fails AM_READ_PLUS Open an existing file with Read/Write access. If file does not exist, Open fails AM_WRITE_PLUS Create new file with Read/Write access. If file does exist, content is discarded AM_APPEND_PLUS Open an existing file with Append (read/write) access. If file does not exist, Open creates a new file
SYS_FILE_STATUS (ENUM) ¶ TYPE SYS_FILE_STATUS : File status Actual file status of the specified file. InOut: Name Comment FS_OK File could be opened FS_NO_FILE No file available FS_ILLEGAL_POS Illegal position in the file FS_FULL No more space on the filesystem FS_EOF End of file reached
SysFileClose (FUN) ¶ FUNCTION SysFileClose : RTS_IEC_RESULT Close a file specified by handle InOut: Scope Name Type Comment Return SysFileClose RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library) Input hFile RTS_IEC_HANDLE Handle of the file
SysFileCopy (FUN) ¶ FUNCTION SysFileCopy : RTS_IEC_RESULT Copy one file to another. A standard path will be added to the filename, if no path is specified. InOut: Scope Name Type Comment Return SysFileCopy RTS_IEC_RESULT The runtime system error code (see CmpErrors.library) Input szDestFileName STRING Destination file name. File name can contain an absolute or relative path to the file. Path entries must be separated with a Slash (/) and not with a Backslash (\)! szSourceFileName STRING Source file name. File name can contain an absolute or relative path to the file. Path entries must be separated with a Slash (/) and not with a Backslash (\)! pulCopied POINTER TO __XWORD Number of bytes copied
SysFileDelete (FUN) ¶ FUNCTION SysFileDelete : RTS_IEC_RESULT Delete the file specified by name. A standard path will be added in the runtime system to the filename, if no path is specified. InOut: Scope Name Type Comment Return SysFileDelete RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library) Input szFileName STRING File name. File name can contain an absolute or relative path to the file. Path entries must be separated with a Slash (/) and not with a Backslash (\)!
SysFileDeleteByHandle (FUN) ¶ FUNCTION SysFileDeleteByHandle : RTS_IEC_RESULT Delete the file specified by handle InOut: Scope Name Type Comment Return SysFileDeleteByHandle RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library) Input hFile RTS_IEC_HANDLE Handle of the file
SysFileEOF (FUN) ¶ FUNCTION SysFileEOF : RTS_IEC_RESULT Check, if end of file is reached Note End of file is only checked after a read operation with SysFileRead! But after a SysFileWrite or SysFileSetPos call, the function returns ERR_FAILED (no end of file)! InOut: Scope Name Type Comment Return SysFileEOF RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_OK: End of file reached at reading beyond the end of the file ERR_FAILED: No end of file reached ERR_PARAMETER: hFile is invalid Input hFile RTS_IEC_HANDLE Handle of the file
SysFileFlush (FUN) ¶ FUNCTION SysFileFlush : RTS_IEC_RESULT Flush the file cache and write into the file InOut: Scope Name Type Comment Return SysFileFlush RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors_Itfs.library): ERR_OK: Succeeded flushing the file ERR_FAILED: Error occurred during file flush ERR_NOTIMPLEMENTED: File flush is not implemented ERR_NOT_SUPPORTED: File flush not available on the target Input hFile RTS_IEC_HANDLE Handle of the file
SysFileGetName (FUN) ¶ FUNCTION SysFileGetName : POINTER TO STRING Get the file name from file specified by handle InOut: Scope Name Type Comment Return SysFileGetName POINTER TO STRING File name of the specified file Input hFile RTS_IEC_HANDLE Handle of the file
SysFileRename (FUN) ¶ FUNCTION SysFileRename : BOOL InOut: Scope Name Type Return SysFileRename BOOL Inout Const FileOldName STRING FileNewName STRING