Back to Aurora Vision Studio website

You are here: Start » Filter Reference » System » File System » RemoveFile_ByDiskUsage (RemoveFile ByDiskUsage)

RemoveFile_ByDiskUsage (RemoveFile ByDiskUsage)

Advanced

Module: FoundationLite

Removes files sorted by size until disk usage drops below the specified threshold.

Name Type Range Description
Input value inDirectory Directory Directory from which the files will be deleted
Input value inMaxDiskUsage Real 0.0 - 1.0 Maximum allowed disk usage (0.0 - 1.0). Files are removed until usage drops below this value
Input value inSortingOrder SortingOrder Sorting order by file size. Descending starts from biggest files, Ascending from smallest
Input value inMask String Filter pattern
Input value inMaskType FileNameFilter Filter type to use with the mask
Input value inRecursive Bool Process subdirectories recursively
Input value inRemoveDirectories Bool Specifies whether to also delete directories that become empty after files are deleted from them
Output value outRemoved FileArray List of actually deleted entries
Output value outRemovedSize Long Size of the deleted files in bytes

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError inMaxDiskUsage must be in range [0.0, 1.0].

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of RemoveFile filter group visible as ByDiskUsage.