Main Content

matlab.addons.isAddonEnabled

Determine if add-on is enabled

collapse all in page

Syntax

isenabled = matlab.addons.isAddonEnabled(name)
isenabled = matlab.addons.isAddonEnabled(identifier)
isenabled = matlab.addons.isAddonEnabled(___,version)

Description

isenabled = matlab.addons.isAddonEnabled(name) returns true if the add-on with the specified name is enabled. Otherwise, it returns false. If matlab.addons.isAddonEnabled is unable to find the specified add-on, it displays an error.

If multiple versions of an add-on are installed, you must specify a version.

example

isenabled = matlab.addons.isAddonEnabled(identifier) returns true if the add-on with the specified identifier is enabled. Otherwise, it returns false. If matlab.addons.isAddonEnabled is unable to find the specified add-on, it displays an error.

example

isenabled = matlab.addons.isAddonEnabled(___,version) also specifies the version of the add-on. Use this syntax with any of the arguments in previous syntaxes.

example

Examples

collapse all

Suppose that you have an add-on called Random File Name Creator installed on your system. Get the list of installed add-ons and determine if Random File Name Creator is enabled.

Get the list of installed add-ons.

addons = matlab.addons.installedAddons
 addons =

  1×4 table

             Name                   Version     Enabled                  Identifier              
    ___________________________    _________    _______    ______________________________________

    "Random File Name Creator"     "1.0"         true      "75442144-f751-4011-bf0e-32b6fb2f1433"

Determine if Random File Name Creator is enabled. MATLAB® confirms that the add-on is enabled.

matlab.addons.isAddonEnabled('Random File Name Creator')
ans =

  logical

   1

Suppose that you have versions 2.0 and 4.0 of an add-on called My Toolbox installed on your system. Disable version 4.0 of the add-on and confirm that it is disabled.

Get the list of installed add-ons.

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"

Disable My Toolbox version 4.0 by specifying the first item in the returned list of identifiers. Then, confirm that it is disabled.

matlab.addons.disableAddon(addons.Identifier(1),'4.0')
matlab.addons.isAddonEnabled(addons.Identifier(1),'4.0')
ans =

  logical

   0

Input Arguments

collapse all

Name of the add-on, specified as a character vector or string. To determine the name of an add-on, use the matlab.addons.installedAddons function.

Unique identifier of the add-on, specified as a character vector or string. To determine the unique identifier of an add-on, use the matlab.addons.installedAddons function.

Version of the add-on, specified as a character vector or string. To determine the version of an add-on, use the matlab.addons.installedAddons function.

Version History

Introduced in R2017b

See Also

| |

Topics