The MATLAB Runtime Startup Options

Set MATLAB Runtime Options

Set MATLAB^® Runtime options, such as -nojvm, -nodisplay, or -logfile by performing either of the following tasks.

Using the Additional Runtime Settings area of the compiler apps.
Using the mcc command, specify the -R switch.

Use a Compiler App

In the Additional Runtime Settings area of the compiler apps, you can set the following options.

Note: Not all options are available for all compilation targets.

Set MATLAB Runtime Startup Options Using the Compiler Apps

MATLAB Runtime Startup Option	This option...	Set the options by...
`-nojvm`	Disables the Java^® Virtual Machine (JVM™), which is enabled by default. This can help improve the MATLAB Runtime performance.	Select the No JVM checkbox.
`-nodisplay`	On Linux^®, launches the MATLAB Runtime without display functionality.	In the Settings box, enter `-R -nodisplay`.
`-logfile`	Writes information about the MATLAB Runtime startup to a logfile.	Select the Create log file checkbox. Enter the path to the logfile, including the logfile name, in the Log File box.

Set MATLAB Runtime Startup Options Using the mcc Command Line

When you use the command line, specify the -R switch to invoke the MATLAB Runtime startup options you want to use.

Following are examples of using mcc -R to invoke -nojvm, -nodisplay, and -logfile when building a C standalone (designated by the -m switch).

Set -nojvm

Set -nodisplay (Linux Only)

Set -logfile

Set -nojvm, -nodisplay, and -logfile With One Command

Retrieve MATLAB Runtime Startup Options

Use these functions to return data about the MATLAB Runtime state when working with shared libraries.

Function and Signature When to Use Return Value

bool mclIsMCRInitialized() Use mclIsMCRInitialized() to determine whether or not the MATLAB Runtime has been properly initialized. Boolean (true or false). Returns true if MATLAB Runtime is already initialized, else returns false.

bool mclIsJVMEnabled() Use mclIsJVMEnabled() to determine if the MATLAB Runtime was launched with an instance of a Java Virtual Machine (JVM). Boolean (true or false). Returns true if MATLAB Runtime is launched with a JVM instance, else returns false.

const char* mclGetLogFileName() Use mclGetLogFileName() to retrieve the name of the log file used by the MATLAB Runtime. Character string representing log file name used by the MATLAB Runtime.

bool mclIsNoDisplaySet()

Use mclIsNoDisplaySet() to determine if -nodisplay option is enabled.

Boolean (true or false). Returns true if -nodisplay is enabled, else returns false.

Note: false is always returned on Windows^® systems since the -nodisplay option is not supported on Windows systems.

Caution When running on Mac, if -nodisplay is used as one of the options included in mclInitializeApplication, then the call to mclInitializeApplication must occur before calling mclRunMain.

Note: All of these attributes have properties of write-once, read-only.

Retrieve Information About MATLAB Runtime Startup Options

 const char* options[4];     
    options[0] = "-logfile";    
    options[1] = "logfile.txt";
    options[2] = "-nojvm";
    options[3] = "-nodisplay"; 
    if( !mclInitializeApplication(options,4) )
    {
        fprintf(stderr, 
                "Could not initialize the application.\n");
        return -1;
    }
    printf("MCR initialized : %d\n", mclIsMCRInitialized());
    printf("JVM initialized : %d\n", mclIsJVMEnabled());
    printf("Logfile name : %s\n", mclGetLogFileName());
    printf("nodisplay set : %d\n", mclIsNoDisplaySet());
    fflush(stdout);

Was this topic helpful?

Documentation