compiler.build.StandaloneApplicationOptions
Syntax
Description
creates a default standalone application options object using a MATLAB® function, class, or app specified using opts
= compiler.build.StandaloneApplicationOptions(AppFile
)AppFile
. Use the
StandaloneApplicationOptions
object as an input to the compiler.build.standaloneApplication
and compiler.build.standaloneWindowsApplication
functions.
creates a standalone application options object with options specified using one or more
name-value arguments.opts
= compiler.build.standaloneApplicationOptions(AppFile
,Name,Value
)
Examples
Create Standalone Application Options Object
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\R2024b\toolbox\compiler\packagingResources\default_icon_48.png' ExecutableName: 'magicsquare' ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2024b\toolbox\compiler\packagingResources\default_splash.png' ExecutableVersion: '1.0.0.0' AppFile: 'C:\Program Files\MATLAB\R2024b\extern\examples\compiler\magicsquare.m' TreatInputsAsNumeric: off AdditionalFiles: {} AutoDetectDataFiles: on ExternalEncryptionKey: [0×0 struct] ObfuscateArchive: off SecretsManifest: '' SupportPackages: {'autodetect'} 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\R2024b\toolbox\compiler\packagingResources\default_icon_48.png' ExecutableName: 'magicsquare' ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2024b\toolbox\compiler\packagingResources\default_splash.png' ExecutableVersion: '1.0.0.0' AppFile: 'C:\Program Files\MATLAB\R2024b\extern\examples\compiler\magicsquare.m' TreatInputsAsNumeric: off AdditionalFiles: {} AutoDetectDataFiles: on ExternalEncryptionKey: [0×0 struct] ObfuscateArchive: off SecretsManifest: '' SupportPackages: {'autodetect'} 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);
Customize a Standalone Application Options Object Using Name-Value Arguments
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\R2024b\toolbox\compiler\packagingResources\default_splash.png'
ExecutableVersion: '2.0'
AppFile: 'D:\Documents\MATLAB\work\mymagic.m'
TreatInputsAsNumeric: on
AdditionalFiles: {}
AutoDetectDataFiles: on
ExternalEncryptionKey: [0×0 struct]
ObfuscateArchive: off
SecretsManifest: ''
SupportPackages: {'autodetect'}
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';
Use the StandaloneApplicationOptions
object as an input to the
compiler.build.standaloneApplication
function to build a standalone
application.
compiler.build.standaloneApplication(opts);
Input Arguments
AppFile
— Path to main file
character vector | string scalar
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 pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: OutputDir='D:\work\myproject'
AdditionalFiles
— Additional files
character vector | string scalar | cell array of character vectors | string array
Additional files and folders to include in the standalone application, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Paths can be relative to the current working directory or absolute.
Example: 'AdditionalFiles',["myvars.mat","myfunc.m"]
Data Types: char
| string
| cell
AutoDetectDataFiles
— Flag to automatically include data files
'on'
(default) | on/off logical value
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 asload
andfopen
) are automatically included in the standalone application. This is the default behavior.If you set this property to
'off'
, then you must add data files to the application using theAdditionalFiles
property.
Example: 'AutoDetectDataFiles','Off'
Data Types: logical
CustomHelpTextFile
— Path to help file
character vector | string scalar
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
EmbedArchive
— Flag to embed deployable archive
'on'
(default) | on/off logical value
Flag to embed the deployable 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 deployable executable.If you set this property to
'off'
, then the function generates the deployable archive as a separate file.
Example: 'EmbedArchive','Off'
Data Types: logical
ExecutableIcon
— Path to icon image
character vector | string scalar
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\packagingResources\default_icon_48.png'
Example: 'ExecutableIcon','D:\Documents\MATLAB\work\images\myIcon.png'
Data Types: char
| string
ExecutableName
— Name of generated application
character vector | string scalar
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
ExecutableSplashScreen
— Path to splash screen image
character vector | string scalar
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\compiler\packagingResources\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
ExecutableVersion
— Executable version
'1.0.0.0'
(default) | character vector | string scalar
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
ExternalEncryptionKey
— Paths to encryption key and loader files
scalar struct
Since R2024b
Paths to the external AES encryption key and MEX key loader files, specified
as a scalar struct with exactly two row char vector or string scalar fields
named EncryptionKeyFile
and
RuntimeKeyLoaderFile
, respectively. Both struct fields
are required. File paths can be relative to the current working directory or
absolute.
For example, specify the encryption key as encrypt.key
and
loader file as loader.mexw64
using struct
keyValueStruct
.
keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'
The encryption key file must be in one of the following supported formats:
Binary 256-bit AES key, with a 32 byte file size
Hex encoded AES key, with a 64 byte file size
The MEX file loader retrieves the decryption key at runtime and must be an interface with the following arguments:
prhs[0]
— Input, char array specified as the static value'get'
prhs[1]
— Input, char array specified as the CTF component UUIDplhs[0]
— Output, 32 byte UINT8 numeric array or 64 byte hex encoded char array, depending on the key format
Avoid sharing the same key across multiple CTFs.
Example: 'ExternalEncryptionKey',keyValueStruct
Data Types: struct
ObfuscateArchive
— Flag to obfuscate deployable archive
'off'
(default) | on/off logical value
Flag to obfuscate the deployable 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 folder structures and file names in the deployable archive are obfuscated from the end user, and user code and data contained in MATLAB files are placed into a user package within the archive. Additionally, all.m
files are converted to P-files before packaging. This option is equivalent to usingmcc
with-j
and-s
specified.If you set this property to
'off'
, then the deployable archive is not obfuscated. This is the default behavior.
Example: 'ObfuscateArchive','on'
Data Types: logical
OutputDir
— Path to output directory
character vector | string scalar
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
SecretsManifest
— Path to JSON manifest file
character vector | string scalar
Since R2024b
Path to a secret manifest JSON file that specifies the secret keys to be embedded in the deployable archive, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.
If your MATLAB code calls the getSecret
, getSecretMetadata
, or isSecret
function, you must specify the secret keys to embed in
the deployable archive in a JSON secret manifest file. If your code calls
getSecret
and you do not specify the
SecretsManifest
option, MATLAB
Compiler™ issues a warning and generates a template JSON file in the output
folder named
.
Modify this file by specifying the secret key names in the Embedded field.<component_name>
_secrets_manifest.json
The setSecret
function is not deployable. To embed secret keys in a
deployable archive, you must call setSecret
in MATLAB before you build the archive.
For more information on deployment using secrets, see Handle Sensitive Information in Deployed Applications.
Example: 'SecretsManifest','D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'
Data Types: char
| string
SupportPackages
— Support packages
'autodetect'
(default) | 'none'
| string scalar | cell array of character vectors | string array
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
TreatInputsAsNumeric
— Flag to interpret command line inputs
'off'
(default) | on/off logical value
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. This is the default behavior.
Example: 'TreatInputsAsNumeric','on'
Data Types: logical
Verbose
— Flag to control build verbosity
'off'
(default) | on/off logical value
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. This is the default behavior.
Example: 'Verbose','on'
Data Types: logical
Output Arguments
opts
— Standalone application options object
StandaloneApplictionOptions
object
Standalone application build options, returned as a
StandaloneApplictionOptions
object.
Version History
Introduced in R2020b
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)