Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 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)
SysFileAsync Library Documentation ¶ Company System Title SysFileAsync Version 3.5.19.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder SysFileAsync Description 1 ¶ Asynchronous file access Contents: ¶ DUT tSysFileClose (Struct) tSysFileCopy (Struct) tSysFileDelete (Struct) tSysFileDeleteByHandle (Struct) tSysFileEOF (Struct) tSysFileGetName (Struct) tSysFileGetPath (Struct) tSysFileGetPos (Struct) tSysFileGetSize (Struct) tSysFileGetSizeByHandle (Struct) tSysFileGetStatus (Struct) tSysFileGetTime (Struct) tSysFileOpen (Struct) tSysFileRead (Struct) tSysFileRename (Struct) tSysFileSetPos (Struct) tSysFileWrite (Struct) Documentation (GVL) General Information: USAGE of the FB: SysFileAsyncFB (FunctionBlock) SysFileCloseAsync (Method) SysFileCopyAsync (Method) SysFileDeleteAsync (Method) SysFileDeleteByHandleAsync (Method) SysFileEOFAsync (Method) SysFileGetNameAsync (Method) SysFileGetPathAsync (Method) SysFileGetPosAsync (Method) SysFileGetSizeAsync (Method) SysFileGetSizeByHandleAsync (Method) SysFileGetStatusAsync (Method) SysFileGetTimeAsync (Method) SysFileOpenAsync (Method) SysFileReadAsync (Method) SysFileRenameAsync (Method) SysFileSetPosAsync (Method) SysFileWriteAsync (Method) Indices and tables ¶ 1 Based on SysFileAsync.library, last modified 02.03.2023, 11:05:38. LibDoc 4.4.0.0-b.27 The content file SysFileAsync.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 02.03.2023, 11:05:40.
DUT ¶ tSysFileClose (Struct) tSysFileCopy (Struct) tSysFileDelete (Struct) tSysFileDeleteByHandle (Struct) tSysFileEOF (Struct) tSysFileGetName (Struct) tSysFileGetPath (Struct) tSysFileGetPos (Struct) tSysFileGetSize (Struct) tSysFileGetSizeByHandle (Struct) tSysFileGetStatus (Struct) tSysFileGetTime (Struct) tSysFileOpen (Struct) tSysFileRead (Struct) tSysFileRename (Struct) tSysFileSetPos (Struct) tSysFileWrite (Struct)
tSysFileClose (STRUCT) ¶ TYPE tSysFileClose : STRUCT Parameter to close a file asynchronously InOut: Name Type Comment pulOut POINTER TO RTS_IEC_RESULT [OUT] Pointer to the runtime system error code (see CmpErrors2 Interface Library)
tSysFileCopy (STRUCT) ¶ TYPE tSysFileCopy : STRUCT Parameter to copy a file asynchronously InOut: Name Type Comment szDestFile STRING(254) 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 (\)! szSrcFile STRING(254) 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 [OUT] Number of bytes copied pulOut POINTER TO RTS_IEC_RESULT [OUT] Pointer to the runtime system error code (see CmpErrors2 Interface Library)
tSysFileDelete (STRUCT) ¶ TYPE tSysFileDelete : STRUCT Parameter to delete the file specified by name InOut: Name Type Comment szFile STRING(254) 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 (\)! pulOut POINTER TO RTS_IEC_RESULT [OUT] Pointer to the runtime system error code (see CmpErrors2 Interface Library)
tSysFileDeleteByHandle (STRUCT) ¶ TYPE tSysFileDeleteByHandle : STRUCT Parameter to delete the file specified by handle InOut: Name Type Comment pulOut POINTER TO RTS_IEC_RESULT [OUT] Pointer to the runtime system error code (see CmpErrors2 Interface Library)
tSysFileEOF (STRUCT) ¶ TYPE tSysFileEOF : STRUCT Parameter to 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: Name Type Comment pulOut POINTER TO RTS_IEC_RESULT [OUT] Pointer to the runtime system error code (see CmpErrors2 Interface 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
tSysFileGetName (STRUCT) ¶ TYPE tSysFileGetName : STRUCT Parameter to get the file name InOut: Name Type Comment pszOut REFERENCE TO STRING [OUT] File name of the specified file
tSysFileGetPath (STRUCT) ¶ TYPE tSysFileGetPath : STRUCT Parameter to get the path of this file. If a path is specified in the filename, the path will be extracted from the filename. If no path is specified in the filename, the standard path for this file extension type will be returned. InOut: Name Type Comment szFileName STRING(254) File name. Can contain an absolute or relative path szPath STRING(254) Path for this file diMaxLen DINT [OUT] Maximum size in bytes of path length pulOut POINTER TO RTS_IEC_RESULT [OUT] Pointer to the runtime system error code (see CmpErrors2 Interface Library)