luadocs/content/lua.scripts.api.manual/dtutils.file/filename_increment.md
Bill Ferguson b69d752221 [lua scripts] created manual from script comments
[lua scripts api] created manual from embedded library documentation

[lua api] created stub to contain lua api manual
2020-12-12 15:14:19 -05:00

762 B

title id weight draft author
filename_increment filename_increment 90 false people

NAME

filename_increment

SYNOPSIS

add a two digit increment to a filename

USAGE

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

filepath - string - filename to increment

DESCRIPTION

filename_increment solves the problem of filename conflict by adding an increment to the filename. If the supplied filename has no increment then "01" is added to the basename. If the filename already has an increment, then 1 is added to it and the filename returned.

RETURN VALUE

result - string - the incremented filename

LIMITATIONS

The filename will be incremented to a maximum of 99.