listRequiredFiles

Get files required by specified project files

Syntax

requiredfiles = listRequiredFiles(proj,files)

Description

requiredfiles = listRequiredFiles(proj,files) returns the names of the project files that the specified files require to run.

Examples

Get Required Files

Open the Times Table App project. Use currentProject to create a project object.

openExample("matlab/TimesTableProjectExample")
proj = currentProject;

Get the files required by the Times Table app file.

file = "source/timestable.mlapp"
requiredfiles = listRequiredFiles(proj,file);

requiredfiles = 

  2×1 string array

    "C:\myProjects\examples\TimesTableApp\source\timestable.mlapp"
    "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"

Input Arguments

proj — Project

matlab.project.Project object

Project, specified as a matlab.project.Project object. Use currentProject to create a project object from the currently loaded project.

files — Path of project files

cell array of character vectors | string array | ProjectFile object array

Path of project files including file extensions, specified as a cell array of character vectors, a string array, or a ProjectFile object array. Specify files as absolute file paths or paths relative to the project root folder. The files must be within the project root folder.

Output Arguments

requiredfiles — Required project files

string array

Required project files, returned as a string array.

Version History

Introduced in R2019a