matlab.addons.install

アドオンのインストール

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

構文

newAddon = matlab.addons.install(fileName)
newAddon = matlab.addons.install(fileName,agreeToLicense)
newAddon = matlab.addons.install(fileName,installOption)
newAddon = matlab.addons.install(fileName,agreeToLicense,installOption)

説明

newAddon = matlab.addons.install(fileName) は、fileName で指定したアドオンをインストールします。アドオンのいずれかのバージョンが既にインストールされている場合、MATLAB® は以前のバージョンを上書きします。

MATLAB はアドオンを既定のアドオン インストール フォルダーにインストールします。既定のアドオン インストール フォルダーの変更方法を含む詳細については、アドオンの取得と管理を参照してください。

matlab.addons.install はツールボックスのインストールのみをサポートしています。

例

newAddon = matlab.addons.install(fileName,agreeToLicense) は、agreeToLicense が true の場合、アドオンをインストールする前にライセンス許諾に同意します。

例

newAddon = matlab.addons.install(fileName,installOption) は、installOption が 'add' の場合、以前にインストール済みのバージョンを上書きせずにアドオンをインストールします。それ以外の場合は、アドオンのいずれかのバージョンが既にインストールされていると、MATLAB は以前のバージョンを上書きします。

例

newAddon = matlab.addons.install(fileName,agreeToLicense,installOption) は、指定したライセンスとインストール オプションを使用してアドオンをインストールします。

例

すべて折りたたむ

My toolbox.mltbx ツールボックス ファイルが C:\Downloads\ フォルダー内にあり、ツールボックスにライセンス許諾が含まれているものとします。ツールボックスをインストールし、ライセンスへの同意を示すことで、MATLAB によってライセンス許諾のダイアログ ボックスが開かれないようにします。

toolboxFile = 'C:\Downloads\My toolbox.mltbx';
agreeToLicense = true;
matlab.addons.install(toolboxFile,agreeToLicense)

ツールボックスがインストールされていることを確認します。

addons = matlab.addons.installedAddons
 addons =

  1×4 table

             Name                   Version     Enabled                  Identifier              
    ___________________________    _________    _______    ______________________________________

    "My Toolbox"                   "2.0"         true      "6de8682e-9c3c-407e-bad7-aa103d738d08"

システム上に My Toolbox というツールボックスの Version 2.0 がインストールされていると仮定します。Version 2.0 を上書きせずに、このツールボックスの Version 4.0 をインストールします。

現在の作業フォルダーに 'My toolbox_v4.0.mltbx' ツールボックス ファイルがあるとします。ツールボックスの追加を指定して、インストール済みのバージョンを上書きせずにツールボックスをインストールします。

toolboxFile = 'My toolbox_v4.0.mltbx';
installOption = 'add';
matlab.addons.install(toolboxFile, installOption)
ans =

  1×4 table

          Name           Version    Enabled                  Identifier              
    _________________    _______    _______    ______________________________________

    "My toolbox_v4.0"     "4.0"      true      "6de8682e-9c3c-407e-bad7-aa103d738d08"

ツールボックスにライセンス許諾が含まれている場合は、ダイアログ ボックスが開き、インストールの前にライセンスに同意するよう求められます。

ツールボックスの以前のバージョンがそのままインストールされていることを確認します。

addons = matlab.addons.installedAddons
addons =

  2×4 table

             Name                   Version     Enabled                  Identifier              
    ___________________________    _________    _______    ______________________________________

    "My Toolbox_v4.0"              "4.0"         true      "6de8682e-9c3c-407e-bad7-aa103d738d08"
    "My Toolbox"                   "2.0"         false     "6de8682e-9c3c-407e-bad7-aa103d738d08"

入力引数

すべて折りたたむ

インストールするファイル名。文字ベクトルまたは string として指定します。ファイル名は有効なツールボックス インストール ファイル (*.mltbx) でなければなりません。ファイル名には絶対パスまたは相対パスを指定できます。

ライセンス許諾に同意するかどうかを表します。true または false として指定します。既定の設定では、agreeToLicense は false です。

アドオンにライセンス許諾がある場合、以下のようになります。

  • agreeToLicense が false の場合は、MATLAB によってダイアログ ボックスが表示され、ライセンスに同意するかインストールをキャンセルすることができます。

  • agreeToLicense が true の場合、MATLAB はライセンス許諾ダイアログ ボックスを開かずにアドオンをインストールします。agreeToLicense を true に設定すると、ライセンス許諾の条件に同意することになります。アドオンをインストールする前に、必ずライセンス許諾を確認してください。

アドオンにライセンス許諾がない場合、agreeToLicense の値はインストールに影響しません。

アドオンの上書きまたは追加を示します。'overwrite' または 'add' として指定します。既定では、installOption は 'overwrite' に設定されています。

アドオンのいずれかのバージョンがインストール済みの場合、以下のようになります。

  • installOption が 'overwrite' の場合、MATLAB はアドオンのインストール済みのバージョンをすべて上書きします。

  • installOption が 'add' の場合、MATLAB は以前にインストール済みのバージョンを上書きせずにアドオンをインストールします。

出力引数

すべて折りたたむ

新しいアドオンの情報。以下の列をもつ table として返されます。

フィールド説明型
名前アドオンの名前string スカラー
バージョンアドオンのバージョンstring スカラー
Enabledアドオンが有効であるかどうかlogical
識別子一意のアドオン識別子string スカラー

バージョン履歴

R2018b で導入

参考

|

トピック