compiler.build.standaloneApplication
Syntax
Description
compiler.build.standaloneApplication(
creates a deployable standalone application using a MATLAB® function, class, or app specified by AppFile
)AppFile
. The
executable type is determined by your operating system. The generated executable does not
include MATLAB Runtime or an installer.
compiler.build.standaloneApplication(
creates a standalone application with additional options specified using one or more
name-value arguments. Options include the executable name, help text, and icon image.AppFile
,Name,Value
)
compiler.build.standaloneApplication(
creates a standalone application with additional options specified using a
opts
)compiler.build.StandaloneApplicationOptions
object
opts
. You cannot specify any other options using name-value
arguments.
Examples
Create Standalone Application
Create a standalone application using a function file that generates a magic square.
In MATLAB, locate the MATLAB code that you want to deploy as a standalone application. For this
example, compile using the file magicsquare.m
.
appFile = fullfile(which('magicsquare.m'));
Build a standalone application using the
compiler.build.standaloneApplication
command.
compiler.build.standaloneApplication(appFile);
This syntax generates the following files within a folder named
magicsquarestandaloneApplication
in your current working directory:
includedSupportPackages.txt
— Text file that lists all support files included in the application.magicsquare.exe
ormagicsquare
— Executable file that has the.exe
extension if compiled on a Windows® system, or no extension if compiled on Linux® or macOS systems.run_magicsquare.sh
— Shell script file that sets the library path and executes the application. This file is only generated on Linux and macOS systems.mccExcludedFiles.log
— Log file that contains a list of any toolbox functions that were not included in the application. For information on non-supported functions, see MATLAB Compiler Limitations.readme.txt
— Text file that contains information on deployment prerequisites and the list of files to package for deployment.requiredMCRProducts.txt
— Text file that contains product IDs of products required by MATLAB Runtime to run the application.unresolvedSymbols.txt
— Text file that contains information on unresolved symbols.
To run magicsquare
from MATLAB with the input argument 4
, navigate to the
magicsquarestandaloneApplication
folder and execute one of the
following commands based on your operating system:
Operating System | Test in MATLAB Command Window |
---|---|
Windows | !magicsquare 4 |
macOS | system(['./run_magicsquare.sh ',matlabroot,'
4']); |
Linux | !./magicsquare 4 |
The application outputs a 4
-by-4
magic
square.
16 2 3 13 5 11 10 8 9 7 6 12 4 14 15 1
To run your standalone application outside of MATLAB, see Run Standalone Application.
Customize Standalone Application
Create a standalone application and customize it using name-value arguments.
Write a MATLAB function that uses a subfunction to compute the diagonal components of a
magic square. Save the functions to files named mymagicdiag.m
and
mydiag.m
.
function out = mymagicdiag(in)
X = magic(in);
out = mydiag(X);
function out = mydiag(in)
out = [diag(in)]';
Build the standalone application using mymagicdiag.m
. Use
name-value pair arguments to specify the executable name, add the
mydiag.m
function file, and interpret command line inputs as
numeric doubles.
compiler.build.standaloneApplication('mymagicdiag.m', ... 'ExecutableName','MagicDiagApp', ... 'AdditionalFiles','mydiag.m', ... 'TreatInputsAsNumeric','On')
To run MagicDiagApp
from MATLAB with the input argument 4
, navigate to the
MagicDiagAppstandaloneApplication
folder and execute one of the
following commands based on your operating system:
Operating System | Test in MATLAB Command Window |
---|---|
Windows | !MagicDiagApp 4 |
macOS | system(['./run_MagicDiagApp.sh ',matlabroot,'
4']); |
Linux | !./MagicDiagApp 4 |
The application outputs the diagonal entries of a
4
-by-4
magic
square.
16 11 6 1
Create Multiple Applications Using Options Object
Create multiple standalone applications on a Windows system using a compiler.build.StandaloneApplicationOptions
object.
Create a standalone application using the file
magicsquare.m
.
appFile = fullfile(which('magicsquare'));
Create a StandaloneApplicationOptions
object using
appFile
. Use name-value arguments to specify a common output
directory, interpret command line inputs as numeric doubles, and display progress
information during the build process.
opts = compiler.build.StandaloneApplicationOptions(appFile,... 'OutputDir','D:\Documents\MATLAB\work\MagicBatch',... 'TreatInputsAsNumeric','On',... '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: on AdditionalFiles: {} AutoDetectDataFiles: on ExternalEncryptionKey: [0×0 struct] ObfuscateArchive: off SecretsManifest: '' SupportPackages: {'autodetect'} Verbose: on OutputDir: 'D:\Documents\MATLAB\work\MagicBatch'
Build a standalone application by passing the
StandaloneApplicationOptions
object as an input to the build
function.
compiler.build.standaloneApplication(opts);
To create a new standalone application using the function file
example2.m
with the same options, use dot notation to modify the
AppFile
of the existing
StandaloneApplicationOptions
object before running the build function
again.
opts.AppFile = 'example2.m';
compiler.build.standaloneApplication(opts);
By modifying the AppFile
argument and recompiling, you can create
multiple applications using the same options object.
Get Build Information from Standalone Application
Create a standalone application and save information about the build
type, generated files, included support packages, and build options to a
compiler.build.Results
object.
Compile using the file magicsquare.m
.
results = compiler.build.standaloneApplication('magicsquare.m')
results = BuildType: 'standaloneApplication' Files: {2×1 cell} IncludedSupportPackages: {} Options: [1×1 compiler.build.StandaloneApplicationOptions]
The Files
property contains the paths to the
magicsquare
standalone executable and
readme.txt
files.
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 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
opts
— Standalone application build options
StandaloneApplicationOptions
object
Standalone application build options, specified as a compiler.build.StandaloneApplicationOptions
object.
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
results
— Build results
compiler.build.Results
object
Build results, returned as a compiler.build.Results
object. The Results
object contains:
The build type, which is
'standaloneApplication'
Paths to the compiled files
A list of included support packages
Build options, specified as a
StandaloneApplicationOptions
object
Tips
To create a standalone application from the system command prompt using this function, use the
matlab
function with the-batch
option. For example:matlab -batch compiler.build.standaloneApplication('mymagic.m')
Version History
Introduced in R2020b
Comando de MATLAB
Ha hecho clic en un enlace que corresponde a este comando de MATLAB:
Ejecute el comando introduciéndolo en la ventana de comandos de MATLAB. Los navegadores web no admiten comandos de MATLAB.
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)