Next Available Filename
Updated 11 May 2021
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 while calculating. This function offers one simple solution: call the function with the required file (or folder) name, the required suffix (including the starting integer) and the file extension (if any), and it will return the next unused name.
Note that unlike some other submissions on FEX, this function compares the number *values*, not the literal filenames! This means you will not get "x001" if "x1" or "x01" already exist in the specified location.
%% Inputs %%
Three text inputs are required (can be string scalars or char vectors):
1. The basic file or folder name, without the file extension (if any). If the location to be checked for existing files is not the current directory then the basic name must use a relative or absolute path to that location.
2. the suffix, 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 (before the file extension), and the number will be incremented to identify the first unused name starting from the number provided in the suffix. Thus the suffix defines:
* the starting value (can be zero or any positive integer, i.e. 0, 1, 2, etc.).
* the minimum length of the output number (use leading zeros as required).
* any literal characters.
3. The file extension, if required. For folders and files without extensions use '' or "".
%% Examples %%
%%% Current directory contains files 'A1.m', 'A2.m', and 'A4.m':
ans = 'A3.m'
ans = 'A003.m'
%%% Subdirectory 'HTML' contains folders 'B(1)', 'B(2)', and 'B(4)':
ans = 'B(3)'
ans = 'B(003)'
>> nextname('HTML\B','(1)','',false) % default = name only.
ans = 'B(3)'
>> nextname('HTML\B','(1)','',true) % prepend same path as the input name.
ans = 'HTML\B(3)'
Stephen23 (2023). Next Available Filename (https://www.mathworks.com/matlabcentral/fileexchange/64108-next-available-filename), MATLAB Central File Exchange. Retrieved .
MATLAB Release Compatibility
Platform CompatibilityWindows macOS Linux
Inspired by: Natural-Order Filename Sort, auto_rename, Avoid file overwrite
Inspired: Making a new .txt or .xlsx file automatically, Customizable Natural-Order Sort, Natural-Order Filename Sort
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!Start Hunting!
Discover Live Editor
Create scripts with code, output, and formatted text in a single executable document.
Simplify string handling.
* Accepts string scalar or char vector inputs.
* Separate file extension input (allows for no-ext names and folders with periods).
* Simplify documentation examples.
* Optional third input selects to return name only or same path as input name.
* Improve efficiency.
* Handle single matched subfolder.
* Add check for no matching files.
* Update HTML docs.