Main Content

compiler.package.installer

MATLAB Compiler によって生成されたファイル用のインストーラーの作成

R2020a 以降

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

構文

compiler.package.installer(results)
compiler.package.installer(results,Name,Value)
compiler.package.installer(results,'Options',opts)
compiler.package.installer(files,filePath,'ApplicationName',appName)
compiler.package.installer(files,filePath,'ApplicationName',appName,Name,Value)
compiler.package.installer(files,filePath,'Options',opts)

説明

compiler.package.installer(results) は、関数 compiler.build から生成された compiler.build.Results オブジェクト results を使用してインストーラーを作成します。

例

compiler.package.installer(results,Name,Value) は、compiler.build.Results オブジェクト results と、名前と値の引数を 1 つ以上使って指定した追加オプションを用いてインストーラーを作成します。

例

compiler.package.installer(results,'Options',opts) は、compiler.build.Results オブジェクト results と、InstallerOptions オブジェクト opts で指定されたインストーラー オプションを使用してインストーラーを作成します。InstallerOptions オブジェクトを使用する場合、名前と値の引数を使用して他のオプションを指定することはできません。

例

compiler.package.installer(files,filePath,'ApplicationName',appName) は、mcc コマンドによって生成されたファイル用のインストーラーを作成します。インストールされるアプリケーションの名前は appName で指定します。インストーラーのファイル拡張子は、関数が実行されるオペレーティング システムによって決まります。

例

compiler.package.installer(files,filePath,'ApplicationName',appName,Name,Value) は、mcc コマンドによって生成されたファイル用のインストーラーを作成します。インストールされるアプリケーションの名前は appName で指定します。インストーラーは、オプションの名前と値の引数を使用してカスタマイズできます。

例

compiler.package.installer(files,filePath,'Options',opts) は、mcc コマンドによって生成されたファイル用のインストーラーを作成します。このときに、InstallerOptions オブジェクト opts によって指定されたインストーラー オプションを使用します。InstallerOptions オブジェクトを使用する場合、名前と値の引数を使用して他のオプションを指定することはできません。

例

例

すべて折りたたむ

関数 compiler.build.standaloneApplication からの結果を使用して、スタンドアロン アプリケーションのインストーラーを作成します。

MATLAB® で、スタンドアロン アプリケーションとしてデプロイする MATLAB コードを見つけます。この例では、matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用してコンパイルします。

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

compiler.build.standaloneApplication コマンドを使用して、スタンドアロン アプリケーションをビルドします。

results = compiler.build.standaloneApplication(appFile);

関数 compiler.package.installer を使用して、スタンドアロン アプリケーションのインストーラーを作成します。

compiler.package.installer(results);
関数は、magicsquareinstaller という名前のフォルダー内に MyAppInstaller という名前のインストーラーを生成します。

アプリケーションの既定のインストール フォルダーは、ターゲット マシン上の %ProgramFiles% 環境変数の値です。

関数 compiler.build.standaloneApplication からの結果を使用してスタンドアロン アプリケーションのインストーラーを作成し、名前と値の引数を使用してカスタマイズします。

matlabroot\extern\examples\compiler にある magicsquare.m ファイルへのパスを保存します。

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

compiler.build.standaloneApplication コマンドを使用して、スタンドアロン アプリケーションをビルドします。

results = compiler.build.standaloneApplication(appFile);

関数 compiler.package.installer で Results オブジェクトを使用して、スタンドアロン アプリケーションのインストーラーを作成します。名前と値の引数を使用してインストーラー名を指定し、インストーラーに MATLAB Runtime を含めます。

compiler.package.installer(results,...
    'InstallerName','MyMagicInstaller',...
    'RuntimeDelivery','installer');
関数は、magicsquareinstaller という名前のフォルダー内に MyMagicInstaller という名前のインストーラーを生成します。

関数 compiler.build.standaloneApplication からの結果を使用して、Windows® システムでスタンドアロン アプリケーションのインストーラーを作成します。InstallerOptions オブジェクトを使用してインストーラーをカスタマイズします。

matlabroot\extern\examples\compiler にある magicsquare.m ファイルへのパスを保存します。

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

compiler.build.standaloneApplication コマンドを使用して、スタンドアロン アプリケーションをビルドします。

results = compiler.build.standaloneApplication(appFile);

InstallerOptions オブジェクトを作成します。名前と値の引数を使用して、アプリケーション名、作成会社、作成者名、インストーラー名、および概要を指定します。

opts = compiler.package.InstallerOptions(results,...
    'ApplicationName','MagicSquare_Generator',...
    'AuthorCompany','Boston Common',...
    'AuthorName','Frog',...
    'InstallerName','MagicSquare_Installer',...
    'Summary','Generates a magic square.')
opts = 

  InstallerOptions with properties:

           RuntimeDelivery: 'web'
           InstallerSplash: 'C:\Program Files\MATLAB\R2024b\toolbox\compiler\packagingResources\default_splash.png'
             InstallerIcon: 'C:\Program Files\MATLAB\R2024b\toolbox\compiler\packagingResources\default_icon_48.png'
             InstallerLogo: 'C:\Program Files\MATLAB\R2024b\toolbox\compiler\packagingResources\default_logo.png'
               PackageType: 'auto'
           AdditionalFiles: {}
     AddRemoveProgramsIcon: 'C:\Program Files\MATLAB\R2024b\toolbox\compiler\packagingResources\default_icon_48.png'
                AuthorName: 'Frog'
               AuthorEmail: ''
             AuthorCompany: 'Boston Common'
                   Summary: 'Generates a magic square.'
               Description: ''
         InstallationNotes: ''
                  Shortcut: 'D:\Work\magicsquarestandaloneApplication\magicsquare.exe'
                   Version: '1.0'
             InstallerName: 'MagicSquare_Installer'
           ApplicationName: 'MagicSquare_Generator'
                 OutputDir: '.\MagicSquare_Generatorinstaller'
    DefaultInstallationDir: 'C:\Program Files\MagicSquare_Generator'
                   Verbose: 'off'

Results オブジェクトと InstallerOptions オブジェクトを関数 compiler.package.installer への入力として使用し、スタンドアロン アプリケーションのインストーラーを作成します。

compiler.package.installer(results,'Options',opts);
関数は、MagicSquare_Generatorinstaller という名前のフォルダー内に MagicSquare_Installer という名前のインストーラーを生成します。

Windows システムのスタンドアロン アプリケーションのインストーラーを作成します。

魔方陣を生成する MATLAB 関数を記述します。この関数を mymagic.m という名前のファイルに保存します。

function out = mymagic(in)
out = magic(in)

mcc コマンドを使用して、スタンドアロン アプリケーションをビルドします。

mcc -m mymagic.m
mymagic.exe
mccExcludedFiles.log
readme.txt
requiredMCRProducts.txt

関数 compiler.package.installer を使用して、スタンドアロン アプリケーションのインストーラーを作成します。

compiler.package.installer('mymagic.exe',...
    'D:\Documents\MATLAB\work\MagicSquare\requiredMCRProducts.txt',...
    'ApplicationName','MagicSquare_Generator')
関数は、MagicSquare_Generatorinstaller という名前のフォルダー内に MyAppInstaller.exe という名前のインストーラーを生成します。

名前と値の引数を使用して、スタンドアロン アプリケーションのインストーラーをカスタマイズします。

compiler.build.standaloneApplication コマンドを使用して、スタンドアロン アプリケーションをビルドします。

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

生成された requiredMCRProducts.txt ファイルへのパスを保存します。

runtimeProducts = fullfile(buildResults.Options.OutputDir,'requiredMCRProducts.txt')

スタンドアロン アプリケーションのビルド結果からのファイルのリストを保存します。

fileList = buildResults.Files

オプションで fileList を変更して、さらにファイルをインストーラーに追加できます。追加ファイルはアプリケーションの実行可能ファイルと共に、インストール ディレクトリにインストールされます。

fileList = [fileList; {'UsageNotes.txt'}];

関数 compiler.package.installer を使用して、スタンドアロン アプリケーションのインストーラーを作成します。

compiler.package.installer(fileList, runtimeProducts,...
    'ApplicationName','CustomMagicSquare',...
    'InstallerName','Installer_With_Addl_Files',...
    'Summary','See UsageNotes.txt for info.')

InstallerOptions オブジェクトを使用して、Windows システムのスタンドアロン アプリケーションのインストーラーをカスタマイズします。

InstallerOptions オブジェクトを作成します。

opts = compiler.package.InstallerOptions('ApplicationName','MagicSquare_Generator',...
    'AuthorCompany','Boston Common',...
    'AuthorName','Frog',...
    'InstallerName','MagicSquare_Installer',...
    'Summary','Generates a magic square.')
opts = 

  InstallerOptions with properties:

           RuntimeDelivery: 'web'
           InstallerSplash: 'C:\Program Files\MATLAB\R2024b\toolbox\compiler\packagingResources\default_splash.ico'
             InstallerIcon: 'C:\Program Files\MATLAB\R2024b\toolbox\compiler\packagingResources\default_icon_48.ico'
             InstallerLogo: 'C:\Program Files\MATLAB\R2024b\toolbox\compiler\packagingResources\default_logo.png'
               PackageType: 'auto'
           AdditionalFiles: {}
     AddRemoveProgramsIcon: ''
                AuthorName: 'Frog'
               AuthorEmail: ''
             AuthorCompany: 'Boston Common'
                   Summary: 'Generates a magic square.'
               Description: ''
         InstallationNotes: ''
                  Shortcut: ''
                   Version: '1.0'
             InstallerName: 'MagicSquare_Installer'
           ApplicationName: 'MagicSquare_Generator'
                 OutputDir: '.\MagicSquare_Generator'
    DefaultInstallationDir: 'C:\Program Files\MagicSquare_Generator'
                   Verbose: 'off'

InstallerOptions オブジェクトを入力として関数に渡します。

compiler.package.installer('mymagic.exe','requiredMCRProducts.txt','Options',opts)

入力引数

すべて折りたたむ

ビルド結果。compiler.build.Results オブジェクトとして指定します。関数 compiler.build からの出力を保存することで、Results オブジェクトを作成します。

インストール用のファイルとフォルダーのリスト。文字ベクトル、string スカラー、文字ベクトルの cell 配列、または string 配列として指定します。これらのファイルは、通常、mcc コマンドまたは関数 compiler.build によって生成され、インストールされるアプリケーションの実行に必要な追加のファイルおよびフォルダーも含めることができます。追加ファイルはアプリケーションの実行可能ファイルと共に、インストール ディレクトリにインストールされます。

  • 特定のリリースで生成されたファイルは、同じリリースの関数 compiler.package.installer を使用してパッケージ化できます。

  • あるオペレーティング システム上のタイプ .ctf のファイルは、別のオペレーティング システムで関数 compiler.package.installer を使用してパッケージ化できます。ただし、ビルド コマンドと関数 compiler.package.installer のリリースが同じである場合に限られます。

例: {'mymagic.exe','UsageNotes.txt'}

データ型: char | string

MATLAB Compiler™ によって生成された requiredMCRProducts.txt ファイルへのパス。

例: 'D:\Documents\MATLAB\work\MagicSquare\requiredMCRProducts.txt'

データ型: char | string

インストールされるアプリケーションの名前。文字ベクトルまたは string スカラーとして指定します。

例: 'MagicSquare_Generator'

データ型: char | string

インストーラー オプション。InstallerOptions オブジェクトとして指定します。

名前と値の引数

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

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

例: 'Version','9.5' は、インストールされているアプリケーションのバージョンを指定します。

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

例: 'AdditionalFiles',["myimage.png","data.mat"]

データ型: char | string | cell

[プログラムの追加と削除] アイコン。文字ベクトルまたは string スカラーとして指定します。イメージは、設定内の Windows アプリケーションのリストでアイコンとして使用されます。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

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

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

例: 'AddRemoveProgramsIcon',"win_icon.png"

データ型: char | string

インストールされるアプリケーションの名前。文字ベクトルまたは string スカラーとして指定します。

例: 'ApplicationName','MagicSquare_Generator'

データ型: char | string

アプリケーションを作成した会社名。文字ベクトルまたは string スカラーとして指定します。

例: 'AuthorCompany','Boston Common'

データ型: char | string

アプリケーション作成者の電子メール アドレス。文字ベクトルまたは string スカラーとして指定します。

例: 'AuthorEmail','frog@example.com'

データ型: char | string

アプリケーション作成者の名前。文字ベクトルまたは string スカラーとして指定します。

例: 'AuthorName','Frog'

データ型: char | string

インストーラーがアプリケーションをインストールする既定のディレクトリ。文字ベクトルまたは string スカラーとして指定します。

パスを指定しない場合、各オペレーティング システムの既定のパスは次のとおりです。

オペレーティング システム既定のインストール ディレクトリ
WindowsC:\Program Files\appName
Linux®/usr/appName
macOS/Applications/appName

例: 'DefaultInstallationDir','C:\Users\MW_Programs\MagicSquare_Generator'

データ型: char | string

アプリケーションの詳細な説明。文字ベクトルまたは string スカラーとして指定します。

例: 'Description','The MagicSquare_Generator application generates an n-by-n matrix constructed from the integers 1 through n2 with equal row and column sums.'

データ型: char | string

アプリケーションの使用に関する追加要件についてのメモ。文字ベクトルまたは string スカラーとして指定します。

例: 'InstallationNotes','This is a Linux installer.'

データ型: char | string

インストールされるアプリケーションのアイコンとして使用するイメージ ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。

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

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

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

インストーラーのロゴとして使用するイメージ ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。ロゴのサイズは 112 x 290 ピクセルに変更されます。

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

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

例: 'InstallerLogo','D:\Documents\MATLAB\work\images\myLogo.png'

インストーラー ファイルの名前。文字ベクトルまたは string スカラーとして指定します。拡張子は、関数が実行されるオペレーティング システムによって決まります。

例: 'InstallerName','MagicSquare_Installer'

インストーラーのスプラッシュ スクリーンとして使用するイメージ ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。スプラッシュ スクリーンのアイコンのサイズは 400 x 400 ピクセルに変更されます。

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

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

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

インストーラーの保存先フォルダーへのパス。文字ベクトルまたは string スカラーとして指定します。

パスを指定しない場合、各オペレーティング システムの既定のパスは次のとおりです。

オペレーティング システム既定のインストール ディレクトリ
Windows.\appNameinstaller
Linux./appNameinstaller
macOS./appNameinstaller

上記のディレクトリ内の . は、現在の作業ディレクトリを表します。

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

生成されるインストーラーのファイル タイプの選択肢。

  • 'auto' — インストーラーの作成時に適切なパッケージ タイプをインストーラーで自動的に選択するオプション。インストーラーのサイズが 2 GB 以上の場合、インストーラーは ZIP ファイルとしてパッケージ化されます。これは既定のオプションです。

  • 'zip' — 新しいインストーラーの作成時に ZIP ファイルを出力として生成するオプション。このオプションは Windows でのみサポートされています。

例: 'PackageType','zip'

データ型: char | string

MATLAB Runtime の引き渡しオプション。次のいずれかとして指定します。

  • 'web' — アプリケーションのインストール時にインストーラーが MathWorks® の Web サイトから MATLAB Runtime をダウンロードするオプション。このオプションは既定の動作です。

  • 'installer' — アプリケーションのインストール時に MathWorks Web サイトに接続せずにインストールできるように、インストーラー内に MATLAB Runtime を含めるオプション。エンド ユーザーがインターネットにアクセスできない可能性があると考えられる場合は、このオプションを使用します。

  • 'none' — アプリケーションのインストール時に MATLAB Runtime をインストールしないオプション。エンド ユーザーが別の方法を使用して MATLAB Runtime をインストールすると考えられる場合は、このオプションを使用します。 (R2024a 以降)

メモ

'web' オプションまたは 'installer' オプションのいずれかを使用する場合、完全な MATLAB Runtime がインストールされます。1 つ以上の特定の MATLAB Compiler アプリケーションを実行できる最小限の MATLAB Runtime インストーラーを作成するには、compiler.runtime.customInstaller を参照してください。 (R2024b 以降)

例: 'RuntimeDelivery','installer'

データ型: char | string

インストール時にインストーラーがショートカットを作成するファイルまたはフォルダーへのパス。文字ベクトルまたは string スカラーとして指定します。

例: 'Shortcut','.\mymagic.exe'

データ型: char | string

アプリケーションの概要説明。文字ベクトルまたは string スカラーとして指定します。

例: 'Summary','Generates a magic square.'

データ型: char | string

インストールされるアプリケーションのバージョン番号。文字ベクトルまたは string スカラーとして指定します。

例: 'Version','2.0'

データ型: char | string

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

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

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

例: 'Verbose','on'

データ型: logical

ヒント

  • この関数で作成されたインストーラーは、MATLAB Compiler により生成されたアーティファクトと、オプションで完全な MATLAB Runtime をインストールします。1 つ以上の特定の MATLAB Compiler アプリケーションを実行できる最小限の MATLAB Runtime インストーラーを作成するには、compiler.runtime.customInstaller を参照してください。

バージョン履歴

R2020a で導入

参考

| | |