Returns the next available filename or foldername, creating the name by incrementing a numbered suffix.
On occasion it may be required to save files without knowing or requiring a particular number sequence, for example when saving interim results or backups during large calculations. Using an internal counter is one option, but this does not work when there are already existing files with those names, or when the code is stopped-and-started or throws errors. This function offers one simple solution: call the function with the required file (or folder) name and the required suffix and it will return the next unused name.
%% Inputs %%
Only two inputs are required:
1. The file or folder name string (1xN char), either a relative or absolute path.
2. the suffix string (1xN char), which must contain the starting number. Some examples of suffixes are: '0', '_1', '(5)', '.backup.0001', '_temp_050', etc.. This suffix will be appended to the file/folder name, and the number will be incremented to identify the first unused name starting from the number provided in the suffix. Thus the suffix controls:
* the starting number (zero or any positive integer, e.g. 0, 1, 2, etc).
* the minimum length of the output number (use leading zeros as required).
* any literals and other required characters (note: this function does not check if the literals are permitted by the filesystem. User beware!)
%% Examples %%
Given a directory containing files 'A1.m', 'A2.m', and 'A4.m':
ans = A0.m
ans = A3.m
ans = A003.m
Stephen Cobeldick (2019). Next Available Filename (https://www.mathworks.com/matlabcentral/fileexchange/64108-next-available-filename), MATLAB Central File Exchange. Retrieved .
* Improve efficiency.
* Handle single matched subfolder.
* Add check for no matching files.
* Update HTML docs.