Get the contents of a specified directory
Updated 5 May 2018

NOTE: this function is now available from the IoSR Matlab Toolbox as iosr.general.getContents.
cont = get_contents(directory)
cont = get_contents(directory,options)
[cont,dirflag] = get_contents(...)

This function returns the contents of a specified directory.

cont = get_contents(directory) returns the files and folders in directory and returns them to the cell array cont. It ignores hidden files and folders (those starting '.'). Directory must be a character array (string).

cont = get_contents(directory,options) allow search options to be specified. The options are specified in parameter/value pairs, and include:
'rec' {false} | true
Search recursively within the subfolders of the specified directory.
'path' {'relative'} | 'full'
Specifies whether returned paths are full or relative to the specified directory.
'sort' {false} | true
Specify whether the output is sorted alphabetically.
'filter' {'all'} | 'files' | 'folders' | '*.ext' | str
This option allows a filter to be specified. 'files' returns names of all files in the directory. 'folders' returns names of all folders in the directory. '*.ext', where 'ext' is a user-specified file extension, returns all files with the extension '.ext'. str may be any string; only elements that contain str will be returned (files or folders). str is case-sensitive.

[cont,dirflag] = get_contents(...) returns a logical array dirflag, the same size as cont, indicating whether each element is a directory.


Ex. 1

% Return all m-files in the current directory

cont = get_contents(cd,'filter','*.m')

Ex. 2

% Return all files in the current directory and its
% sub-directories

cont = get_contents(cd,'rec',true)

Ex. 3

% Return all files in current directory with names
% containing 'foo'

% may return files and folders:
[cont,dirflag] = get_contents(cd,'filter','foo')

% use dirflag to limit:
cont = cont(~dirflag);

Cite As

Christopher Hummersone (2024). get_contents (, GitHub. Retrieved .

MATLAB Release Compatibility
Created with R2010b
Compatible with any release
Platform Compatibility
Windows macOS Linux
Find more on Search Path in Help Center and MATLAB Answers

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Versions that use the GitHub default branch cannot be downloaded

Version Published Release Notes

Minor update to file help text and description.
Migrated to GitHub.

Minor update to help text and description.

Simplified interface such that str is not required (now varargin option). Also made sort and rec flags logical rather than strings.

Some bug fixes and additional inputs options permitted, including a recursive option. Input now in parameter/value pairs.

Some bug fixes. Additionally outputs a directory flag.

Added a keyword, allowing specific file extensions to be returned

Updated help

To view or report issues in this GitHub add-on, visit the GitHub Repository.
To view or report issues in this GitHub add-on, visit the GitHub Repository.