# compiler.build.StandaloneApplicationOptions

Options for building standalone applications

## Syntax

``opts = compiler.build.StandaloneApplicationOptions(AppFile)``
``opts = compiler.build.standaloneApplicationOptions(AppFile,Name,Value)``

## Description

example

````opts = compiler.build.StandaloneApplicationOptions(AppFile)` creates a default standalone application options object using a MATLAB® function, class, or app specified using `AppFile`. Use the `StandaloneApplicationOptions` object as an input to the `compiler.build.standaloneApplication` and `compiler.build.standaloneWindowsApplication` functions.```

example

````opts = compiler.build.standaloneApplicationOptions(AppFile,Name,Value)` creates a standalone application options object with options specified using one or more name-value arguments.```

## Examples

collapse all

Create a `StandaloneApplicationOptions` object using file input.

For this example, use the file `magicsquare.m` located in `matlabroot\extern\examples\compiler`.

```appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m'); opts = compiler.build.StandaloneApplicationOptions(appFile)```
```opts = StandaloneApplicationOptions with properties: CustomHelpTextFile: '' EmbedArchive: on ExecutableIcon: 'C:\Program Files\MATLAB\R2021b\toolbox\compiler\resources\default_icon_48.png' ExecutableName: 'magicsquare' ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2021b\toolbox\toolbox\compiler\resources\default_splash.png' ExecutableVersion: '1.0.0.0' AppFile: 'C:\Program Files\MATLAB\R2021b\extern\examples\compiler\magicsquare.m' TreatInputsAsNumeric: off AdditionalFiles: {} AutoDetectDataFiles: on Verbose: off OutputDir: '.\magicsquarestandaloneApplication' ```

You can modify the property values of an existing `StandaloneApplictionOptions` object using dot notation. For example, enable verbose output.

`opts.Verbose = 'on'`
```opts = StandaloneApplicationOptions with properties: CustomHelpTextFile: '' EmbedArchive: on ExecutableIcon: 'C:\Program Files\MATLAB\R2021b\toolbox\compiler\resources\default_icon_48.png' ExecutableName: 'magicsquare' ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2021b\toolbox\toolbox\compiler\resources\default_splash.png' ExecutableVersion: '1.0.0.0' AppFile: 'C:\Program Files\MATLAB\R2021b\extern\examples\compiler\magicsquare.m' TreatInputsAsNumeric: off AdditionalFiles: {} AutoDetectDataFiles: on Verbose: on OutputDir: '.\magicsquarestandaloneApplication' ```

Use the `StandaloneApplicationOptions` object as an input to the `compiler.build.standaloneApplication` function to build a standalone application.

`compiler.build.standaloneApplication(opts);`

Create a `StandaloneApplictionOptions` object and customize it using name-value arguments.

Create a `StandaloneApplicationOptions` object using the function file `mymagic.m`. Use name-value arguments to specify the output directory, set the executable version and icon, and treat inputs as numeric values.

```opts = compiler.build.StandaloneApplicationOptions('mymagic.m',... 'OutputDir','D:\Documents\MATLAB\work\MagicApp',... 'ExecutableIcon','D:\Documents\MATLAB\work\images\magicicon.png',... 'ExecutableVersion','2.0',... 'TreatInputsAsNumeric','On')```
```opts = StandaloneApplicationOptions with properties: CustomHelpTextFile: '' EmbedArchive: on ExecutableIcon: 'D:\Documents\MATLAB\work\images\magicicon.png' ExecutableName: 'mymagic' ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2021b\toolbox\toolbox\compiler\resources\default_splash.png' ExecutableVersion: '2.0' AppFile: 'D:\Documents\MATLAB\work\mymagic.m' TreatInputsAsNumeric: on AdditionalFiles: {} AutoDetectDataFiles: on Verbose: off OutputDir: 'D:\Documents\MATLAB\work\MagicApp' ```

You can modify the property values of an existing `StandaloneApplictionOptions` object using dot notation. For example, enable verbose output.

`opts.Verbose = 'on'`
```opts = StandaloneApplicationOptions with properties: CustomHelpTextFile: '' EmbedArchive: on ExecutableIcon: 'D:\Documents\MATLAB\work\images\magicicon.png' ExecutableName: 'mymagic' ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2021b\toolbox\toolbox\compiler\resources\default_splash.png' ExecutableVersion: '2.0' AppFile: 'D:\Documents\MATLAB\work\mymagic.m' TreatInputsAsNumeric: on AdditionalFiles: {} AutoDetectDataFiles: on Verbose: on OutputDir: 'D:\Documents\MATLAB\work\MagicApp'```

Use the `StandaloneApplicationOptions` object as an input to the `compiler.build.standaloneApplication` function to build a standalone application.

`compiler.build.standaloneApplication(opts);`

## Input Arguments

collapse all

Path to the main file used to build the application, specified as a row character vector or a string scalar. The file must be a MATLAB function, class, or app of one of the following types: `.m`, `.p`, `.mlx`, `.mlapp`, or a valid MEX file.

Example: `'mymagic.m'`

Data Types: `char` | `string`

### Name-Value Arguments

Specify optional comma-separated pairs of `Name,Value` arguments. `Name` is the argument name and `Value` is the corresponding value. `Name` must appear inside quotes. You can specify several name and value pair arguments in any order as `Name1,Value1,...,NameN,ValueN`.

Example: `'EmbedArchive','on'`

Additional files to include in the standalone application, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. File paths can be relative to the current working directory or absolute.

Example: `'AdditionalFiles',["myvars.mat","myfunc.m"]`

Data Types: `char` | `string` | `cell`

Flag to automatically include data files, specified as `'on'` or `'off'`, or as numeric or logical `1` (`true`) or `0` (`false`). A value of `'on'` is equivalent to `true`, and `'off'` is equivalent to `false`. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type `matlab.lang.OnOffSwitchState`.

• If you set this property to `'on'`, then data files that you provide as inputs to certain functions (such as `load` and `fopen`) are automatically included in the standalone application.

• If you set this property to `'off'`, then you must add data files to the application using the `AdditionalFiles` property.

Example: `'AutoDetectDataFiles','Off'`

Data Types: `logical`

Path to a help file containing help text for the end user of the application, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

Example: `'CustomHelpTextFile','D:\Documents\MATLAB\work\help.txt'`

Data Types: `char` | `string`

Flag to embed the standalone archive, specified as `'on'` or `'off'`, or as numeric or logical `1` (`true`) or `0` (`false`). A value of `'on'` is equivalent to `true`, and `'off'` is equivalent to `false`. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type `matlab.lang.OnOffSwitchState`.

• If you set this property to `'on'`, then the function embeds the archive in the standalone executable.

• If you set this property to `'off'`, then the function generates the standalone archive as a separate file.

Example: `'EmbedArchive','Off'`

Data Types: `logical`

Path to the icon image, specified as a character vector or a string scalar. The image is used as the icon for the standalone executable. The path can be relative to the current working directory or absolute. Accepted image types are `.jpg`, `.jpeg`, `.png`, `.bmp`, and `.gif`.

The default path is:

`'`matlabroot`\toolbox\compiler\resources\default_icon_48.png'`

Example: `'ExecutableIcon','D:\Documents\MATLAB\work\images\myIcon.png'`

Data Types: `char` | `string`

Name of the generated application, specified as a character vector or a string scalar. The default value is the file name of `AppFile`. Target output names must begin with a letter or underscore character and contain only alpha-numeric characters or underscores.

Example: `'ExecutableName','MagicSquare'`

Data Types: `char` | `string`

Path to the splash screen image, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute. Accepted image types are `.jpg`, `.jpeg`, `.png`, `.bmp`, and `.gif`. The image is resized to 400 pixels by 400 pixels.

The default path is:

`'`matlabroot`\toolbox\toolbox\compiler\resources\default_splash.png'`

Note

This is only used in Windows® applications built using `compiler.build.standaloneWindowsApplication`.

Example: `'ExecutableSplashScreen','D:\Documents\MATLAB\work\images\mySplash.png'`

Data Types: `char` | `string`

Executable version, specified as a character vector or a string scalar.

Note

This is only used on Windows operating systems.

Example: `'ExecutableVersion','4.0'`

Data Types: `char` | `string`

Path to the output directory where the build files are saved, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

The default name of the build folder is the executable name appended with `standaloneApplication`.

Example: `'OutputDir','D:\Documents\MATLAB\work\MagicSquarestandaloneApplication'`

Data Types: `char` | `string`

Support packages to include, specified as one of the following options:

• `'autodetect'` (default) — The dependency analysis process detects and includes the required support packages automatically.

• `'none'` — No support packages are included. Using this option can cause runtime errors.

• A string scalar, character vector, or cell array of character vectors — Only the specified support packages are included. To list installed support packages or those used by a specific file, see `compiler.codetools.deployableSupportPackages`.

.

Example: ```'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}```

Data Types: `char` | `string` | `cell`

Flag to interpret command line inputs as numeric values, specified as `'on'` or `'off'`, or as numeric or logical `1` (`true`) or `0` (`false`). A value of `'on'` is equivalent to `true`, and `'off'` is equivalent to `false`. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type `matlab.lang.OnOffSwitchState`.

• If you set this property to `'on'`, then command line inputs are treated as numeric MATLAB doubles.

• If you set this property to `'off'`, then command line inputs are treated as MATLAB character vectors.

Example: `'TreatInputsAsNumeric','On'`

Data Types: `logical`

Flag to control build verbosity, specified as `'on'` or `'off'`, or as numeric or logical `1` (`true`) or `0` (`false`). A value of `'on'` is equivalent to `true`, and `'off'` is equivalent to `false`. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type `matlab.lang.OnOffSwitchState`.

• If you set this property to `'on'`, then the MATLAB command window displays progress information indicating compiler output during the build process.

• If you set this property to `'off'`, then the command window does not display progress information.

Example: `'Verbose','On'`

Data Types: `logical`

## Output Arguments

collapse all

Standalone application build options, returned as a `StandaloneApplictionOptions` object.