matlab.apputil.install

Install app from an MLAPPINSTALL file

collapse all in page

Syntax

appinfo = matlab.apputil.install(appfile)

Description

appinfo = matlab.apputil.install(appfile) installs the specified MLAPPINSTALL app file and returns information about the app.

example

Examples

collapse all

Assume you have downloaded an app from File Exchange named EmployeeData. Install it and return information about the installation to the variable appinfo. Later, if you decide to uninstall the app programmatically, you have the app id required to do so.

appinfo = matlab.apputil.install...
   ("C:\myguis\myapps\EmployeeData.mlappinstall")
appinfo = 

          id: 'EmployeeDataApp'
        name: 'EmployeeData'
      status: 'installed'
    location: 'C:\myguis\myapps\EmployeeData.mlappinstall'

Input Arguments

collapse all

Full or partial path of the app file you want to install, specified as a character vector or string scalar.

Example: 'C:\myguis\myapps\myapp.mlappinstall'

Example: "C:\myguis\myapps\myapp.mlappinstall"

Output Arguments

collapse all

Information about the installed app, returned as a structure with the fields:

Installation status, returned as one of the following:

  • 'installed' — New app is installed.

  • 'updated' — Previously installed app is updated.

Unique identifier for the installed app, returned as a character vector.

The ID is for use when running or uninstalling the app programmatically.

Folder where app is installed, returned as a character vector.

Name of installed app as it appears in the apps gallery, returned as a character vector.

More About

collapse all

Tips

  • Installing an app using the matlab -batch command is not supported. To install an app from a script, run MATLAB® interactively using the matlab -r command instead. For more information, see matlab (Windows), matlab (Linux), or matlab (macOS).

Version History

Introduced in R2012b

See Also

| |

Topics