matlab.apputil.install

Install app from an MLAPPINSTALL file

Syntax

appinfo = matlab.apputil.install(appfile)

Description

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

Examples

Install App and Display Information About the Installation

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

appfile — Full or partial path to MLAPPINSTALL file

character vector | string scalar

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

appinfo — Information about installed app

structure

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

status — Installation status

'installed' | 'updated'

Installation status, returned as one of the following:

• 'installed' — New app is installed.

• 'updated' — Previously installed app is updated.

id — Unique identifier

character vector

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

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

location — Folder where app is installed

character vector

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

name — Name of installed app

character vector

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

More About

MLAPPINSTALL Files

In R2024b and earlier, you could package an app as an MLAPPINSTALL file. Starting in R2025a, you can continue to share and run apps packaged as MLAPPINSTALL files and upgrade existing MLAPPINSTALL files. However, when packaging new apps, use the steps described in Package Apps in App Designer.

Version History

Introduced in R2012b