DirRemove (FB; Prefix fildrm)¶

FUNCTION_BLOCK DirRemove EXTENDS CBM.ETrigToA

This function block deletes a directory.
Contrary to the original CAA specification the directory may be removed even if it is opened via ”FILE.DirOpen”.
This behavior is dependent of the underlying operating system and file system.

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.	ETrigToA
	`xAbort`	`BOOL`	`TRUE`: Action is stopped immediately and all outputs are reset to their initial values.	ETrigToA
	`udiTimeOut`	`UDINT`	Defines the time (µs) after which an FB (e.g. requiring an external acknowledgement) aborts operation due to a timeout with error message.	ETrigToA
Output	`xDone`	`BOOL`	`TRUE`: Action successfully completed	ETrigToA
	`xBusy`	`BOOL`	`TRUE`: Function block active	ETrigToA
	`xError`	`BOOL`	`TRUE`: Error occurred, function block aborts action `FALSE`: No error	ETrigToA
	`xAborted`	`BOOL`	`TRUE` : Action aborted by user	ETrigToA
Input	`sDirName`	`CAA.FILENAME`	Directory name
Input	`xRecursive`	`BOOL`	TRUE: Remove all files and sub-directories, FALSE: Directory is only deleted, if empty, i.e. if no files and sub-directories are left; otherwise an error will be dumped
Output	`eError`	ERROR	Local library error ID (5107 - FILE_NOT_EMPTY: Directory not empty; will be generated only if xRecursive = FALSE)