currentProject

Get current project

Syntax

proj = currentProject

Description

example

proj = currentProject gets the currently open project, and returns a project object proj that you can use to manipulate the project programmatically. When the currently open project is running a shortcut, startup file, or shutdown file for a referenced project, currentProject returns the object for the referenced project instead. If no project is open, MATLAB® displays an error.

For more information about working with projects programmatically, see Create and Edit Projects Programmatically

Examples

collapse all

Open the Times Table App example project and get a project object you can use to manipulate the project at the command line.

matlab.project.example.timesTable
proj = currentProject
proj = 

  Project with properties:

                        Name: "Times Table App"
    SourceControlIntegration: "Git"
          RepositoryLocation: "C:\myProjects\examples\repositories\TimesTableApp"
       SourceControlMessages: [1×3 string]
                    ReadOnly: 0
                    TopLevel: 1
                Dependencies: [1×1 digraph]
                  Categories: [1×1 matlab.project.Category]
                       Files: [1×14 matlab.project.ProjectFile]
                   Shortcuts: [1×4 matlab.project.Shortcut]
                 ProjectPath: [1×3 matlab.project.PathFolder]
           ProjectReferences: [1×0 matlab.project.ProjectReference]
                StartupFiles: [1×0 string]
               ShutdownFiles: [1×0 string]
                 Description: "This example project contains the source code and tests for a ...
                  RootFolder: "C:\myProjects\examples\TimesTableApp"
        ProjectStartupFolder: "C:\myProjects\examples\TimesTableApp"

Output Arguments

collapse all

Project, returned as a matlab.project.Project object. Use the matlab.project.Project to programmatically manipulate the currently open project.

Introduced in R2019a