Main Content

compiler.build.StandaloneApplicationOptions

スタンドアロン アプリケーションのビルドのオプション

R2020b 以降

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

構文

opts = compiler.build.StandaloneApplicationOptions(AppFile)
opts = compiler.build.standaloneApplicationOptions(AppFile,Name,Value)

説明

例

opts = compiler.build.StandaloneApplicationOptions(AppFile) は、MATLAB® 関数、クラス、または AppFile を使って指定されたアプリを用いて、既定のスタンドアロン アプリケーション オプション オブジェクトを作成します。StandaloneApplicationOptions オブジェクトを関数 compiler.build.standaloneApplication と関数 compiler.build.standaloneWindowsApplication への入力として使用します。

例

opts = compiler.build.standaloneApplicationOptions(AppFile,Name,Value) は、名前と値の引数を 1 つ以上使って指定したオプションを用いて、スタンドアロン アプリケーション オプション オブジェクトを作成します。

例

すべて折りたたむ

ファイル入力を使用して StandaloneApplicationOptions オブジェクトを作成します。

この例では、matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用します。

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
opts = compiler.build.StandaloneApplicationOptions(appFile)
opts =

  StandaloneApplicationOptions with properties:

        CustomHelpTextFile: ''
              EmbedArchive: on
            ExecutableIcon: 'C:\Program Files\MATLAB\R2023a\toolbox\compiler\packagingResources\default_icon_48.png'
            ExecutableName: 'magicsquare'
    ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2023a\toolbox\compiler\packagingResources\default_splash.png'
         ExecutableVersion: '1.0.0.0'
                   AppFile: 'C:\Program Files\MATLAB\R2023a\extern\examples\compiler\magicsquare.m'
      TreatInputsAsNumeric: off
           AdditionalFiles: {}
       AutoDetectDataFiles: on
                   Verbose: off
                 OutputDir: '.\magicsquarestandaloneApplication'

ドット表記を使用して、既存の StandaloneApplictionOptions オブジェクトのプロパティ値を変更することができます。たとえば、詳細な出力を有効にします。

opts.Verbose = 'on'
opts =

  StandaloneApplicationOptions with properties:

        CustomHelpTextFile: ''
              EmbedArchive: on
            ExecutableIcon: 'C:\Program Files\MATLAB\R2023a\toolbox\compiler\packagingResources\default_icon_48.png'
            ExecutableName: 'magicsquare'
    ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2023a\toolbox\compiler\packagingResources\default_splash.png'
         ExecutableVersion: '1.0.0.0'
                   AppFile: 'C:\Program Files\MATLAB\R2023a\extern\examples\compiler\magicsquare.m'
      TreatInputsAsNumeric: off
           AdditionalFiles: {}
       AutoDetectDataFiles: on
                   Verbose: on
                 OutputDir: '.\magicsquarestandaloneApplication'

StandaloneApplicationOptions オブジェクトを関数 compiler.build.standaloneApplication への入力として使用して、スタンドアロン アプリケーションをビルドします。

compiler.build.standaloneApplication(opts);

StandaloneApplictionOptions オブジェクトを作成し、名前と値の引数を使用してカスタマイズします。

関数ファイル mymagic.m を使用して StandaloneApplicationOptions オブジェクトを作成します。名前と値の引数を使用して出力ディレクトリを指定し、実行可能ファイルのバージョンとアイコンを設定して、入力を数値として扱います。

opts = compiler.build.StandaloneApplicationOptions('mymagic.m',...
    'OutputDir','D:\Documents\MATLAB\work\MagicApp',...
    'ExecutableIcon','D:\Documents\MATLAB\work\images\magicicon.png',...
    'ExecutableVersion','2.0',...
    'TreatInputsAsNumeric','On')
opts =

  StandaloneApplicationOptions with properties:

        CustomHelpTextFile: ''
              EmbedArchive: on
            ExecutableIcon: 'D:\Documents\MATLAB\work\images\magicicon.png'
            ExecutableName: 'mymagic'
    ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2023a\toolbox\compiler\packagingResources\default_splash.png'
         ExecutableVersion: '2.0'
                   AppFile: 'D:\Documents\MATLAB\work\mymagic.m'
      TreatInputsAsNumeric: on
           AdditionalFiles: {}
       AutoDetectDataFiles: on
                   Verbose: off
                 OutputDir: 'D:\Documents\MATLAB\work\MagicApp'

ドット表記を使用して、既存の StandaloneApplictionOptions オブジェクトのプロパティ値を変更することができます。たとえば、詳細な出力を有効にします。

opts.Verbose = 'on'
opts =

  StandaloneApplicationOptions with properties:


        CustomHelpTextFile: ''
              EmbedArchive: on
            ExecutableIcon: 'D:\Documents\MATLAB\work\images\magicicon.png'
            ExecutableName: 'mymagic'
    ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2023a\toolbox\compiler\packagingResources\default_splash.png'
         ExecutableVersion: '2.0'
                   AppFile: 'D:\Documents\MATLAB\work\mymagic.m'
      TreatInputsAsNumeric: on
           AdditionalFiles: {}
       AutoDetectDataFiles: on
                   Verbose: on
                 OutputDir: 'D:\Documents\MATLAB\work\MagicApp'

StandaloneApplicationOptions オブジェクトを関数 compiler.build.standaloneApplication への入力として使用して、スタンドアロン アプリケーションをビルドします。

compiler.build.standaloneApplication(opts);

入力引数

すべて折りたたむ

アプリケーションのビルドに使用するメイン ファイルへのパス。行の文字ベクトルまたは string スカラーとして指定します。このファイルは、MATLAB 関数、クラス、またはアプリで、タイプは .m、.p、.mlx、.mlapp、あるいは有効な MEX ファイルでなければなりません。

例: 'mymagic.m'

データ型: char | string

名前と値の引数

オプションのペアの引数を Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定する必要がありますが、ペアの順序は考慮されません。

R2021a より前では、コンマを使用してそれぞれの名前と値を区切り、Name を引用符で囲みます。

例: OutputDir='D:\work\myproject'

スタンドアロン アプリケーションに含める追加のファイルとフォルダー。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

例: 'AdditionalFiles',["myvars.mat","myfunc.m"]

データ型: char | string | cell

データ ファイルを自動的に含めるためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • このプロパティを 'on' に設定した場合、特定の関数 (load や fopen など) の入力として指定されるデータ ファイルは自動的にスタンドアロン アプリケーションに含められます。これは既定の動作です。

  • このプロパティを 'off' に設定した場合、データ ファイルは AdditionalFiles プロパティを使用してアプリケーションに追加しなければなりません。

例: 'AutoDetectDataFiles','Off'

データ型: logical

アプリケーションのエンド ユーザー向けヘルプ テキストが含まれるヘルプ ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

例: 'CustomHelpTextFile','D:\Documents\MATLAB\work\help.txt'

データ型: char | string

デプロイ可能なアーカイブを組み込むためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • このプロパティを 'on' に設定した場合、関数はアーカイブをデプロイ可能な実行可能ファイルに組み込みます。

  • このプロパティを 'off' に設定した場合、関数はデプロイ可能なアーカイブを別個のファイルとして生成します。

例: 'EmbedArchive','Off'

データ型: logical

アイコン イメージへのパス。文字ベクトルまたは string スカラーとして指定します。イメージは、スタンドアロン実行可能ファイルのアイコンとして使用されます。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。使用可能なイメージのタイプは .jpg、.jpeg、.png、.bmp、.gif です。

既定のパスは次のとおりです。

'matlabroot\toolbox\compiler\packagingResources\default_icon_48.png'

例: 'ExecutableIcon','D:\Documents\MATLAB\work\images\myIcon.png'

データ型: char | string

生成されるアプリケーションの名前。文字ベクトルまたは string スカラーとして指定します。既定値は AppFile のファイル名です。ターゲットの出力名は英字またはアンダースコアで始まっていなければならず、また英数字とアンダースコアのみ使用できます。

例: 'ExecutableName','MagicSquare'

データ型: char | string

スプラッシュ スクリーン イメージへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。使用可能なイメージのタイプは .jpg、.jpeg、.png、.bmp、.gif です。イメージのサイズは 400 x 400 ピクセルに変更されます。

既定のパスは次のとおりです。

'matlabroot\toolbox\compiler\packagingResources\default_splash.png'

メモ

これは、compiler.build.standaloneWindowsApplication を使用してビルドされた Windows® アプリケーションでのみ使用されます。

例: 'ExecutableSplashScreen','D:\Documents\MATLAB\work\images\mySplash.png'

データ型: char | string

実行可能ファイルのバージョン。文字ベクトルまたは string スカラーとして指定します。

メモ

これは Windows オペレーティング システムでのみ使用されます。

例: 'ExecutableVersion','4.0'

データ型: char | string

デプロイ可能なアーカイブを難読化するためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • このプロパティを 'on' に設定した場合、デプロイ可能なアーカイブのフォルダー構造およびファイル名はエンド ユーザーに対して難読化され、MATLAB ファイルに含まれているユーザー コードおよびデータはアーカイブ内のユーザー パッケージに配置されます。また、すべての .m ファイルがパッケージ化の前に P ファイルに変換されます。このオプションは、-j および -s を指定して mcc を使用するのと等価です。

  • このプロパティを 'off' に設定した場合、デプロイ可能なアーカイブは難読化されません。これは既定の動作です。

例: 'ObfuscateArchive','on'

データ型: logical

ビルド ファイルが保存される出力ディレクトリへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

ビルド フォルダーの既定の名前は、実行可能ファイル名に standaloneApplication を追加したものです。

例: 'OutputDir','D:\Documents\MATLAB\work\MagicSquarestandaloneApplication'

データ型: char | string

含めるサポート パッケージ。次のオプションのいずれかとして指定します。

  • 'autodetect' (既定) — 依存関係の解析プロセスにより、必要なサポート パッケージが自動的に検出され、含められます。

  • 'none' — サポート パッケージは含められません。このオプションを使用すると、ランタイム エラーの原因となる可能性があります。

  • string スカラー、文字ベクトル、または文字ベクトルの cell 配列 — 指定されたサポート パッケージのみが含められます。インストールされている、または特定のファイルで使用されるサポート パッケージのリストを表示するには、compiler.codetools.deployableSupportPackages を参照してください。

例: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

データ型: char | string | cell

コマンド ライン入力を数値として解釈するためのフラグ。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • このプロパティを 'on' に設定した場合、コマンド ライン入力は MATLAB double の数値として扱われます。

  • このプロパティを 'off' に設定した場合、コマンド ライン入力は MATLAB 文字ベクトルとして扱われます。これは既定の動作です。

例: 'TreatInputsAsNumeric','on'

データ型: logical

ビルドの詳細を制御するためのフラグ。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • このプロパティを 'on' に設定した場合、MATLAB コマンド ウィンドウには、ビルド プロセス中のコンパイラ出力を示す進行状況情報が表示されます。

  • このプロパティを 'off' に設定した場合、コマンド ウィンドウには進行状況の情報は表示されません。これは既定の動作です。

例: 'Verbose','on'

データ型: logical

出力引数

すべて折りたたむ

スタンドアロン アプリケーションのビルド オプション。StandaloneApplictionOptions オブジェクトとして返されます。

バージョン履歴

R2020b で導入

参考

| | |