DirRename (FB; Prefix fildrn)

FUNCTION_BLOCK DirRename EXTENDS CBM.ETrig

This function block can be used to rename a directory and is optional for the different targets.
Contrary to the original CAA specification the directory may be renamed even if it is opened via ”FILE.DirOpen”.
This behavior is dependent of the underlying operating system and file system.
Whether this function block is implemented or not is explicitly stated and encoded in the return value of the function ”FILE.GetProperty”.
It is not recommended to use this function block to move files (it may work but is system dependent). Please use the appropriate function block ”FILE.Rename” instead.
InOut:

Scope

Name

Type

Comment

Input

sDirNameOld

CAA.FILENAME

Old directory name

sDirNameNew

CAA.FILENAME

New directory name

Output

eError

ERROR

Local library error ID (0: no error; 5101: time out)