matlab.project.rootProject

ルート プロジェクトの取得

ページ内をすべて折りたたむ

構文

proj = matlab.project.rootProject

説明

proj = matlab.project.rootProject は、現在読み込まれているプロジェクトのルート プロジェクトを取得し、プログラムによってルート プロジェクトの操作に使用するプロジェクト オブジェクトを返します。プロジェクトが開いていない場合、MATLAB® は空の配列を返します。参照プロジェクトを操作する場合は、matlab.project.rootProject を使用します。

現在コンテキストをもつプロジェクトを取得する場合、たとえば、プロジェクトで参照プロジェクトへのショートカット、起動ファイル、またはシャットダウン ファイルを実行している場合、代わりに currentProject を使用します。

参照プロジェクトの詳細については、大規模なプロジェクトのコンポーネント化を参照してください。

例

例

すべて折りたたむ

Times Table App サンプル プロジェクトを開き、コマンド ラインでプロジェクトを操作するために、ルート プロジェクトのオブジェクトを取得します。

openExample("matlab/TimesTableProjectExample")
proj = matlab.project.rootProject
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:\Users\myProjects\examples\TimesTableApp"
        ProjectStartupFolder: "C:\myProjects\examples\TimesTableApp"

プロジェクト ファイルを確認します。

files = proj.Files

files = 

  1×14 ProjectFile array with properties:

    Path
    Labels
    Revision
    SourceControlStatus

プロジェクト例 Times Table App を開きます。

openExample("matlab/TimesTableProjectExample")

プロジェクトが読み込まれているかどうかをチェックします。

loaded = ~isempty(matlab.project.rootProject)
loaded =

  logical

   1

プロジェクトを閉じてもう一度チェックします。

close(matlab.project.rootProject)
loaded = ~isempty(matlab.project.rootProject)
loaded =

  logical

   0

出力引数

すべて折りたたむ

プロジェクト。matlab.project.Project オブジェクトとして返されます。matlab.project.Project オブジェクトは、現在開いているプロジェクトをプログラムで操作するために使用します。

バージョン履歴

R2019a で導入

参考

|

トピック