Syntax

Description

license returns the license number for this MATLAB® product. The return value also can be 'demo'
for a demonstration version of MATLAB, 'student', for a student version of
MATLAB, or 'unknown', if the license number cannot be
determined.

license('inuse') displays a list of licenses checked out
in the current MATLAB session. The product list is alphabetical by license feature name.
These names are the same as the valid values for the
feature input.

S = license('inuse',feature)
checks if the product specified by feature is checked out in
the current MATLAB session. If the product is checked out, then
license returns the product name and the user name of
the person who has it checked out. Otherwise, the fields of S
are empty.

[status,errmsg]
= license('checkout',feature)
checks out a license for the specified product. If you specify the optional
second output argument, errmsg, then
license returns the text of any error message
encountered if the checkout is unsuccessful.

Input Arguments

feature — License feature namecharacter vector

License feature name, specified as a character vector. Values of
feature are not case-sensitive. The
INCREMENT lines in a license file indicate the valid
features. To locate your license file, see Where are the license files for MATLAB located?

toggle — Ability to test product license'enable' | 'disable'

Ability to test the existence of a product license, specified as either
'enable' or 'disable'.

If toggle is 'enable',
then the syntax, license('test',feature)
returns 1 when the product license exists and
0 when the product license does not
exist.

If toggle is 'disable',
then the syntax, license('test',feature)
always returns 0 (product license does not
exist) for the specified product.

Note

Disabling a test for a particular product can affect other tests for
the existence of the license, not just tests performed by the
license command.

Output Arguments

S — Checked out productsarray of structures

Checked out products, returned as an array of structures, where each
structure represents a checked-out license. The structures contain two fields:

feature — license feature
name

user — user name of the person who
has the license checked out

If the fields are empty, then the product is not currently
checked out.

status — Test or checkout status1 | 0

Test or checkout status, returned as 1 or
0.

When testing for the existence of a license, 1
indicates that the license exists, and 0
indicates that the license does not exist.

The existence of a license does not necessarily mean that the
license can be checked out or that the product is installed.
status is 1 even if the
license has expired or if a system administrator has excluded you
from using the product.

When checking out a license, 1 indicates that
the checkout is successful, and 0 indicates that
the license function could not check out a
license.

errmsg — Error messagecharacter vector

Error message for unsuccessful license checkout, returned as a character
vector. If the checkout is successful, then errmsg is
empty.