MATLAB Function Reference

license

Return license number or perform licensing task

Syntax

• license
  license('inuse')
  S = license('inuse')
  license('test',feature)
  license('test',feature,toggle)
  license('checkout',feature)
  

Description

license returns the license number for this MATLAB. The return value is always a string but is not guaranteed to be a number. The following table lists text strings that license can return.

String	Description
'demo'	MATLAB is a demonstration version
'student'	MATLAB is the student version
'unknown'	License number cannot be determined

license('inuse') returns a list of licenses checked out in the current MATLAB session. In the list, products are listed alphabetically by their license feature names, i.e., the text string used to identify products in the INCREMENT lines in a License File (license.dat). Note that the feature names returned in the list contain only lower-case characters.

S = license('inuse') returns an array of structures, where each structure represents a checked-out license. The structures contains two fields: feature and user. The feature field contains the license feature name. The user field contains the username of the person who has the license checked out.

license('test',feature) tests if a license exists for the product specified by the text string feature. The license command returns 1 if the license exists and 0 if the license does not exist.

The feature string must be a license feature name, spelled exactly as it appears in the INCREMENT lines in a License File. For example, 'Identification_Toolbox' is the feature name for the System Identification Toolbox. The feature string is not case insensitive and must not exceed 27 characters in length.

Note    Testing for a license only confirms that the license exists. It does not confirm that the license can be checked out. For example, license will return 1 if a license exists, even if the license has expired or if a system administrator has excluded you from using the product in an options file.

license('test',feature,toggle) enables or disables testing of the product specified by the text string feature, depending on the value of toggle. The parameter toggle can have either of two values:

'enable'	The syntax license('test',feature) returns 1 if the product license exists and 0 if the product license does not exist.
'disable'	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 impact other tests for the existence of the license, not just tests performed using the license command.

result = license('checkout',feature) checks out a license for the product identified by the text string feature. The license command returns 1 if it could check out a license for the product and 0 if it could not check out a license for the product.

Examples

Get the license number for this MATLAB.

• license
  

Get a list of licenses currently being used. Note that the products appear in alphabetical order by their license feature name in the list returned.

• license('inuse')
  
  image_toolbox
  map_toolbox
  matlab
  

Get a list of licenses in use with information about who is using the license.

• S = license('inuse');
  
  S(1)
  
  ans = 
  
      feature: 'image_toolbox'
         user: 'juser'
  

Determine if a license exists for the Mapping Toolbox.

• license('test','map_toolbox')
  
  ans =
  
      1
  

Check out a license for the Control System Toolbox.

• license('checkout','control_toolbox')
  
  ans =
  
      1
  

Determine if the license for the Control System Toolbox is checked out.

• license('inuse')
  
  control_toolbox
  image_toolbox
  map_toolbox
  matlab
  

length

light

© 1994-2005 The MathWorks, Inc.