luadocs/content/lua.scripts.api.manual/dtutils.file/create_unique_filename.md

title	id	weight	draft	author
create_unique_filename	create_unique_filename	50	false	people

NAME

create_unique_filename

SYNOPSIS

create a unique filename from the supplied argument

USAGE

local df = require "lib/dtutils.file"
local result = df.create_unique_filename(filepath)

filepath - string - the path and filename requested

DESCRIPTION

create_unique_filename takes a requested filepath and checks to see if it exists. If if doesn't then it's returned intact. If it already exists, then a two digit increment is added to the filename and it is tested again. The increment keeps increasing until either a unique filename is found or there have been 100 attempts.

RETURN VALUE

result - string - the incremented filename

LIMITATIONS

create_unique_filename will only attempt 100 increments.