get_contents

Get the contents of a specified directory

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.

Examples

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);