FILE.DirRemove

Navigation:  Libraries > CT File Access > Function Blocks - File Directory Services >

FILE.DirRemove

Previous pageReturn to chapter overviewNext page

This function block deletes a directory.

The directory cannot be deleted until the access on the properties has been terminated via FILE.DirClose.

Inputs:

xExecute

 

BOOL


xAbort

BOOL

 

udTimeOut

UDINT

 

sDirName

CAA.FILENAME

Directory name

xRecursive

BOOL

Condition for deleting the directory:

TRUE: Directory is deleted including all files,

FALSE: Directory is only deleted, if no files and sub-directories are included; otherwise an error will be dumped

 

Outputs:

xDone

 

BOOL

 

 

xBusy

BOOL

 

xError

BOOL

 

xAborted

BOOL


eError

FILE.ERROR

Error ID

5107 - FILE.NOT_EMPTY:

- Directory not empty; will be generated only if xRecursive = FALSE