File ¶ Close (FunctionBlock) Copy (FunctionBlock) Delete (FunctionBlock) EOF (FunctionBlock) Flush (FunctionBlock) GetAttribute (FunctionBlock) GetPos (FunctionBlock) GetSize (FunctionBlock) GetTime (FunctionBlock) Open (FunctionBlock) Read (FunctionBlock) Rename (FunctionBlock) SetPos (FunctionBlock) Write (FunctionBlock)
Close (FB; Prefix filcl) ¶ FUNCTION_BLOCK Close EXTENDS CBM.ETrig This function block terminates the file access, i.e. closes the file. InOut: Scope Name Type Comment Input hFile CAA.HANDLE File handle Output eError ERROR Local library error ID (0: no error; 5101: time out)
Copy (FB; Prefix filcp) ¶ FUNCTION_BLOCK Copy EXTENDS CBM.ETrigToA This function block copies a file. The target file is created or - if already existent - overwritten. The overwrite mode can be defined with the input ” xOverWrite ”. If the overwrite mode is activated, no write protection may be activated in the existing file. The function block is optional for different targets. Whether this function block is implemented or not is explicitly stated and encoded in the return value of the function ”FILE. GetProperty ”. InOut: Scope Name Type Initial Comment Input sFileNameDest CAA.FILENAME File to which data should be copied; for restrictions concerning the file- and directory names see FILE_Open (FB) sFileNameSource CAA.FILENAME File from which data should be copied, for restrictions concerning the file- and directory names see FILE_Open (FB) xOverWrite BOOL TRUE Overwrite an already existing file; TRUE: yes; FALSE: File will not be overwritten, an error message will be created Output eError ERROR Local library error ID (5105 - FILE_EXIST: Target file already exists; only in case of xOverWrite := FALSE ) szSize CAA.SIZE source file size, copied bytes into the destination file
Delete (FB; Prefix fildl) ¶ FUNCTION_BLOCK Delete EXTENDS CBM.ETrig This function block deletes a file. Contrary to the original CAA specification the file may be deleted even if it is opened via ”FILE. Open ”. This behavior is dependent of the underlying operating system and file system. InOut: Scope Name Type Comment Input sFileName CAA.FILENAME Name of the file to be deleted Output eError ERROR Local library error ID (0: no error; 5101: time out)
EOF (FB; Prefix fileof) ¶ FUNCTION_BLOCK EOF EXTENDS CBM.ETrig This function block sets “xEOF” to “TRUE” if the current offset is equal to the end of the file. If the end of the file has not yet been reached, “FALSE” is returned. InOut: Scope Name Type Comment Input hFile CAA.HANDLE File handle Output eError ERROR Local library error ID (0: no error; 5101: time out) xEOF BOOL End of file is reached, TRUE: yes, FALSE: no
CAA List And Tree Library Documentation ¶ Company CAA Technical Workgroup Title CAA List And Tree Version 3.5.11.0 Categories Intern|CAA|Foundation Namespace LAT Author 3S - Smart Software Solutions GmbH Placeholder CAA List And Tree Description 1 ¶ Generic list and tree interfaces and implementation. With CODESYS 3.5.11.0 there is a Collection Library released. Please use the Collection Library for new projects. Contents: ¶ CAA List and Tree Enums Function Blocks Interfaces GetSupplierVersion (Function) VersionConstants (GVL) Indices and tables ¶ 1 Based on CAA_ListAndTree.library, last modified 03.07.2017, 15:38:58. LibDoc 4.4.0.0-b.27 The content file CAA_ListAndTree.clean.json was generated with CODESYS V3.5 SP11 on 03.07.2017, 15:38:58.
CAA List and Tree ¶ Enums ERROR (Enum) Function Blocks Element Element (Folder) IsLinkedElem (Property) IsListMemberOf (Method) NextElem (Property) PrevElem (Property) TypedElement (FunctionBlock) List List (Folder) AppendElem (Method) InsertElem (Method) PopBackElem (Method) PopElem (Method) PushElem (Method) RemoveElem (Method) ListBase (FunctionBlock) HeadElem (Property) ListIsEmpty (Property) ListSize (Property) TailElem (Property) TypedList (FunctionBlock) AppendElem (Method) InsertElem (Method) PopBackElem (Method) PopElem (Method) PushElem (Method) RemoveElem (Method) Tree Tree (Folder) AddChild (Method) InsertSibling (Method) RemoveTree (Method) TreeBase (FunctionBlock) ChildCount (Property) FirstChild (Property) IsLinkedTree (Property) IsTreeRoot (Property) LastChild (Property) NextSibling (Property) ParentTree (Property) PrevSibling (Property) SiblingCount (Property) TypedTree (FunctionBlock) AddChild (Method) InsertSibling (Method) RemoveTree (Method) TreeTypeId (Property) Interfaces Element IElement (Interface) IsLinkedElem (Property) IsListMemberOf (Method) NextElem (Property) PrevElem (Property) ITypedElement (Interface) List IList (Interface) AppendElem (Method) InsertElem (Method) PopBackElem (Method) PopElem (Method) PushElem (Method) RemoveElem (Method) ISimpleList (Interface) HeadElem (Property) ListIsEmpty (Property) ListSize (Property) TailElem (Property) ITypedList (Interface) AppendElem (Method) InsertElem (Method) ListTypeId (Property) PopBackElem (Method) PopElem (Method) PushElem (Method) RemoveElem (Method) Tree ISimpleTree (Interface) ChildCount (Property) FirstChild (Property) IsLinkedTree (Property) IsTreeRoot (Property) LastChild (Property) NextSibling (Property) ParentTree (Property) PrevSibling (Property) SiblingCount (Property) ITree (Interface) AddChild (Method) InsertSibling (Method) RemoveTree (Method) ITypedTree (Interface) AddChild (Method) InsertSibling (Method) RemoveTree (Method) TreeTypeId (Property)
ERROR (ENUM) ¶ TYPE ERROR : Attributes: qualified_only InOut: Name Initial NO_ERROR 0 FIRST_ERROR 1450 TIME_OUT FIRST_MF 1474 LAST_ERROR 1499
Function Blocks ¶ Element Element (Folder) IsLinkedElem (Property) IsListMemberOf (Method) NextElem (Property) PrevElem (Property) TypedElement (FunctionBlock) List List (Folder) AppendElem (Method) InsertElem (Method) PopBackElem (Method) PopElem (Method) PushElem (Method) RemoveElem (Method) ListBase (FunctionBlock) HeadElem (Property) ListIsEmpty (Property) ListSize (Property) TailElem (Property) TypedList (FunctionBlock) AppendElem (Method) InsertElem (Method) PopBackElem (Method) PopElem (Method) PushElem (Method) RemoveElem (Method) Tree Tree (Folder) AddChild (Method) InsertSibling (Method) RemoveTree (Method) TreeBase (FunctionBlock) ChildCount (Property) FirstChild (Property) IsLinkedTree (Property) IsTreeRoot (Property) LastChild (Property) NextSibling (Property) ParentTree (Property) PrevSibling (Property) SiblingCount (Property) TypedTree (FunctionBlock) AddChild (Method) InsertSibling (Method) RemoveTree (Method) TreeTypeId (Property)
