RemoveFile_ByDiskUsage


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

Syntax

C++
Python
 
def RemoveFile_ByDiskUsage(
	inDirectory: str,
	inMaxDiskUsage: float,
	inSortingOrder: SortingOrder,
	inMask: str,
	/,
	*,
	inMaskType: FileNameFilter = FileNameFilter.Wildcard,
	inRecursive: bool = False,
	inRemoveDirectories: bool = True
)
-> (
	outRemoved: list[str],
	outRemovedSize: int
)

Parameters

Name Type Range Default Description
Input value inDirectory str Directory from which the files will be deleted
Input value inMaxDiskUsage float 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 str Filter pattern
Input value inMaskType FileNameFilter FileNameFilter.Wildcard Filter type to use with the mask
Input value inRecursive bool False Process subdirectories recursively
Input value inRemoveDirectories bool True Specifies whether to also delete directories that become empty after files are deleted from them
Output value outRemoved list[str] List of actually deleted entries
Output value outRemovedSize int Size of the deleted files in bytes