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
|
Inherited from
|
|
Input
|
xExecute
|
BOOL
|
Rising edge: Action starts
Falling edge: Resets outputs
If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values (xDone, xError) are present at the outputs for exactly one cycle.
|
ETrig
|
|
Output
|
xDone
|
BOOL
|
TRUE: Action successfully completed
|
ETrig
|
|
xBusy
|
BOOL
|
TRUE: Function block active
|
ETrig
|
|
xError
|
BOOL
|
TRUE: Error occurred, function block aborts action
FALSE: No error
|
ETrig
|
|
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)
|
|
|