Routines (alphabetical) > Routines: L > LMGR

# LMGR

The LMGR function tests whether a particular licensing mode is in effect. Different licensing modes are specified by keyword; see the “Keywords” section below for a description of each licensing mode.

The LMGR function can also force IDL into time demo mode or report the LMHostid number for the machine in use.

For more information on IDL’s licensing methods, consult the Installing and Licensing IDL manual.

## Examples

Use the following commands to test whether the current IDL session is running in timed demo mode:

Result = LMGR(/DEMO)
IF (Result GT 0) THEN PRINT, "IDL is in Demo Mode"

Use the following commands to generate the LMHostid number for the machine in use:

Result = LMGR(LMHOSTID = myId)
PRINT, "LMHostid for this machine is: ", myId

## Syntax

Result = LMGR( [, /DEMO | , /EMBEDDED | , /RUNTIME | , /STUDENT | , /TRIAL | , /VM] [, EXPIRE_DATE=variable] [, /FORCE_DEMO] [, INSTALL_NUM=variable] [, LMHOSTID=variable] [, SITE_NOTICE=variable])

## Return Value

The function returns True (1) if the mode specified is in effect, or False (0) otherwise.

## Arguments

None

## Keywords

### DEMO

Set this keyword to test whether the current IDL session is running in timed demo mode. Unlicensed copies of IDL and copies running directly from a CD-ROM run in timed demo mode. If the IDL session is running in timed demo mode, no license is used even if one is available.

### EMBEDDED

Set this keyword to test whether the current IDL session is running in embedded mode. Embedded-mode applications contain a built-in version of the IDL license. Examples of applications running in embedded mode are the IDL demo and the IDL registration program.

### EXPIRE_DATE

Set this keyword to a named variable that will receive a string containing the expiration date of the current IDL session if the session is a trial session. This named variable will be undefined if the IDL session has a permanent license.

### FORCE_DEMO

Set this keyword to force the current session into timed demo mode. Forcing an IDL session into demo mode can be useful if you are testing an application that will be run with an unlicensed copy of IDL. Note that you must exit IDL and restart to return to normal licensed mode after forcing IDL into demo mode.

### INSTALL_NUM

Set this keyword to a named variable that will receive a string containing the installation number of the current IDL session. This named variable will be undefined if the IDL session is unlicensed.

### LMHOSTID

Set this keyword equal to a named variable that will contain a string value representing the LMHostid for the machine in use. The LMHostid is used when creating client/server IDL licenses. This keyword returns the string “0” on machines which do not have a unique LMHostid (some Windows machines that use Desktop licensing.)

### RUNTIME

Set this keyword to test whether the current IDL session is running in runtime mode. Runtime-mode applications do not provide access to the IDL Command Line.

Note: The fact that the IDL session is running in runtime mode does not imply that a runtime license is in use. A session in runtime mode may be running in demo mode, Virtual Machine mode, or may have checked out either a runtime or a full IDL license.

### SITE_NOTICE

Set this keyword to a named variable that will receive a string containing the site notice of the current IDL session. This named variable will be undefined if the IDL session is unlicensed.

### STUDENT

Set this keyword to test whether the current IDL session is running in student mode. The IDL Student version, which provides a subset of IDL’s full functionality, is currently the only product that runs in student mode.

### TRIAL

Set this keyword to test whether the current IDL session is running in trial mode. Trial mode licenses allow IDL to operate for a limited time period (generally 30 days) but do not otherwise restrict functionality.

### VM

Set this keyword to test whether the current IDL session is running in IDL Virtual Machine mode. IDL Virtual Machine applications do not provide access to the IDL Command Line. If the IDL session is running in Virtual Machine mode, no license is used even if one is available.

## Version History

Pre 4.0 | Introduced
6.0 | Added VM keyword
7.03 | Deprecated CLIENTSERVER keyword.