compiler.build.dotNETAssembly
Syntax
Description
compiler.build.dotNETAssembly(
creates a
.NET assembly using the MATLAB® functions specified by Files
)Files
.
compiler.build.dotNETAssembly(
creates a .NET assembly with additional options specified using one or more name-value
arguments. Options include the class name, output directory, and additional files to
include.Files
,Name,Value
)
compiler.build.dotNETAssembly(
creates a .NET assembly with a class mapping specified using a
ClassMap
)container.Map
object ClassMap
.
compiler.build.dotNETAssembly(
creates a .NET assembly using ClassMap
,Name,Value
)ClassMap
and additional options specified
using one or more name-value arguments. Options include the assembly name, output directory,
and additional files to include.
compiler.build.dotNETAssembly(
creates a
.NET assembly with options specified using a
opts
)compiler.build.DotNetAssemblyOptions
object opts
.
You cannot specify any other options using name-value arguments.
Examples
Create .NET Assembly Using File
Create a .NET assembly on a Windows® system using a function file that generates a magic square.
In MATLAB, locate the MATLAB function that you want to deploy as a .NET assembly. For this example, use
the file magicsquare.m
located in
.matlabroot
\extern\examples\compiler
appFile = which('magicsquare.m');
Build a .NET assembly using the compiler.build.dotNETAssembly
command.
compiler.build.dotNETAssembly(appFile);
The build function generates the following files within a folder named
magicsquaredotNETAssembly
in your current working directory:
GettingStarted.html
— HTML file that contains information on integrating your assembly.includedSupportPackages.txt
— Text file that lists all support files included in the assembly.magicsquare.dll
— Dynamic-link library file that can be accessed using themwArray
API.magicsquare.xml
— XML file that contains documentation for themwArray
assembly.magicsquare_overview.html
— HTML file that contains requirements for accessing the component and for generating arguments using themwArray
class hierarchy.magicsquareNative.dll
— Dynamic-link library file that can be accessed using the native API.magicsquareNative.xml
— XML file that contains documentation for the native assembly.magicsquareVersion.cs
— C# file that contains version information.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 packaging and interface information.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.
Customize .NET Assembly
Create a .NET assembly on a Windows system and customize it using name-value arguments.
For this example, use the files flames.m
and
flames.mat
located in
.matlabroot
\extern\examples\compiler
appFile = which('flames.m'); MATFile = which('flames.mat');
Build a .NET assembly using the compiler.build.dotNETAssembly
command. Use name-value arguments to specify the assembly name and version, add a MAT
file, and enable verbose output.
compiler.build.dotNETAssembly(appFile,'AssemblyName','FlamesComp', ... 'AssemblyVersion','2.0', ... 'AdditionalFiles',MATFile, ... 'Verbose','on');
Create .NET Assembly Using Class Map Input
Create a .NET assembly on a Windows system using a class map and multiple function files.
Create a containers.Map
object whose keys are class
names and whose values are the locations of function files.
cmap = containers.Map; cmap('Class1') = {'exampleFcn1.m','exampleFcn2.m'}; cmap('Class2') = {'exampleFcn3.m','exampleFcn4.m'};
Build a .NET assembly using the compiler.build.dotNETAssembly
command.
compiler.build.dotNETAssembly(cmap);
Alternatively, you can specify additional options using name-value arguments when you build the .NET assembly.
compiler.build.dotNETAssembly(cmap, ... 'AssemblyName','MyExampleComp', ... 'AssemblyVersion','2.0', ... 'Verbose','on');
Create Multiple Assemblies Using Options Object
Create multiple .NET assemblies on a Windows system using a compiler.build.DotNETAssemblyOptions
object.
For this example, use the file magicsquare.m
located in
.matlabroot
\extern\examples\compiler
appFile = which('magicsquare.m');
Create a DotNETAssemblyOptions
object using
appFile
. Use name-value arguments to specify a common output
directory, generate the assembly archive separately, and enable verbose output.
opts = compiler.build.DotNETAssemblyOptions(appFile, ... 'OutputDir','D:\Documents\MATLAB\work\dotNETBatch', ... 'EmbedArchive','off', ... 'Verbose','on')
opts =
DotNETAssemblyOptions with properties:
AssemblyName: 'example.magicsquare'
ClassMap: [1×1 containers.Map]
DebugBuild: off
EnableRemoting: off
FrameworkVersion: '4.0'
SampleGenerationFiles: {}
StrongNameKeyFile: ''
AssemblyVersion: '1.0.0.0'
EmbedArchive: off
Interface: 'mwarray'
AdditionalFiles: {}
AutoDetectDataFiles: on
ExternalEncryptionKey: [0×0 struct]
ObfuscateArchive: off
SecretsManifest: ''
SupportPackages: {'autodetect'}
Verbose: on
OutputDir: 'D:\Documents\MATLAB\work\dotNETBatch'
Class Map Information
magicsquareClass: {'C:\Program Files\MATLAB\R2024b\extern\examples\compiler\magicsquare.m'}
Build the .NET Assembly using the DotNETAssemblyOptions
object.
compiler.build.dotNETAssembly(opts);
To compile using the function file hello.m
with the same options,
use dot notation to modify the ClassMap
of the existing
COMComponentOptions
object before running the build function
again.
remove(opts.ClassMap, keys(opts.ClassMap)); opts.ClassMap('helloClass') = which('hello.m'); compiler.build.dotNETAssembly(opts);
By modifying the ClassMap
argument and recompiling, you can
compile multiple components using the same options object.
Get Build Information from .NET Assembly
Create a .NET assembly on a Windows system 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.dotNETAssembly('magicsquare.m')
results = Results with properties: BuildType: 'dotNETAssembly' Files: {4×1 cell} IncludedSupportPackages: {} Options: [1×1 compiler.build.DotNETAssemblyOptions]
The Files
property contains the paths to the following compiled files:
magicsquare.dll
magicsquareNative.dll
magicsquare_overview.dll
GettingStarted.html
Input Arguments
Files
— Files implementing MATLAB functions
character vector | string scalar | cell array of character vectors | string array
Files implementing MATLAB functions, 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. Files must have one of the following extensions: .m
, .p
, .mlx
, or .mexa64
.
Example: ["myfunc1.m","myfunc2.m"]
Data Types: char
| string
| cell
ClassMap
— Class map
containers.Map
object
Class map, specified as a containers.Map
object. Map keys are class
names and each value is the set of files mapped to the corresponding class. Files must have one of the following extensions: .m
, .p
, .mlx
, or .mexa64
.
Example: cmap
opts
— .NET assembly build options
compiler.build.DotNetAssemblyOptions
object
.NET assembly build options, specified as a compiler.build.DotNETAssemblyOptions
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: 'Verbose','on'
AdditionalFiles
— Additional files
character vector | string scalar | cell array of character vectors | string array
Additional files and folders to include in the .NET assembly, 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","data.txt"]
Data Types: char
| string
| cell
AssemblyName
— Name of .NET assembly
character vector | string scalar
Name of the .NET assembly, specified as a character vector or a string scalar.
Specify 'AssemblyName'
as a namespace, which is a
period-separated list, such as
companyname.groupname.component
. The name of the
generated library is set to the last entry of the period-separated list. The
name must begin with a letter and contain only alphabetic characters and
periods.
Example: 'AssemblyName','mathworks.dotnet.mymagic'
Data Types: char
| string
AssemblyVersion
— Assembly version
'1.0.0.0'
(default) | character vector | string scalar
Assembly version, specified as a character vector or a string scalar. This option is only used with the MWArray API.
For information on versioning using MATLAB Compiler SDK™, see Versioning.
Example: 'AssemblyVersion','4.0'
Data Types: char
| string
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 .NET assembly.If you set this property to
'off'
, then you must add data files to the assembly using theAdditionalFiles
option.
Example: 'AutoDetectDataFiles','off'
Data Types: logical
ClassName
— Name of .NET class
character vector | string scalar
Name of the .NET class, specified as a character vector or a string scalar.
You cannot specify this option if you use a ClassMap
input.
Class names must meet the .NET class name requirements.
The default value is the name of the first file listed in the
Files
argument appended with
Class
.
Example: 'ClassName','magicsquareClass'
Data Types: char
| string
DebugBuild
— Flag to enable debug symbols
'off'
(default) | on/off logical value
Flag to enable debug symbols, 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 debugging symbol information is included in the compiled artifact. This option also causesmbuild
to pass appropriate debugging flags to the system compiler. The debug option lets you back trace up to the point where you can identify if the failure occurred in the initialization of MATLAB Runtime, the function call, or the termination routine. This option does not let you debug your MATLAB files with an external debugger.If you set this property to
'off'
, then debug symbols are not included. This is the default option.
Example: 'DebugBuild','on'
Data Types: logical
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 deployable archive in the .NET assembly.If you set this property to
'off'
, then the function generates the deployable archive as a separate file.
This option is only used with the MWArray API.
Example: 'EmbedArchive','off'
Data Types: logical
EnableRemoting
— Flag to control remoting type
'off'
(default) | on/off logical value
Flag to control the remoting type of the assembly, 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 builds a remotable assembly.If you set this property to
'off'
, then the function builds an assembly that is not remotable.
Example: 'EnableRemoting','on'
Data Types: logical
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
FrameworkVersion
— .NET Framework or .NET 5.0 or later
'4.0'
(default) | character vector | string scalar
Specify '4.0'
to target any version of the .NET Framework
from 4.6.2 upwards, regardless of minor version increments. To target the
cross-platform .NET 5.0 or later, specify '5.0'
.
Example: 'FrameworkVersion','5.0'
Data Types: char
| string
Interface
— Data API
'mwarray'
| 'matlab-data'
| character vector | string scalar
Data API used for handling data exchange between a .NET application and deployed MATLAB code.
mwarray
— MWArray API. This API works with .NET Framework. This is the default interface on Windows.matlab-data
— MATLAB Data API for .NET. This API requires .NET 5.0 or higher. This is the default interface on macOS.
MathWorks® recommends using the MATLAB Data API for .NET.
Example: 'Interface','matlab-data'
Data Types: char
| string
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 assembly name appended with
dotNETAssembly
.
Example: 'OutputDir','D:\Documents\MATLAB\work\mymagicdotNETAssembly'
Data Types: char
| string
SampleGenerationFiles
— MATLAB sample files
character vector | string scalar | cell array of character vectors | string array
MATLAB sample files used to generate sample .NET driver files for
functions included within the assembly, 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. Files must have a
.m
extension. For more information and limitations, see
Sample Driver File Creation.
Example: 'SampleGenerationFiles',["sample1.m","sample2.m"]
Data Types: char
| string
| cell
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
StrongNameKeyFile
— Path to encryption key
character vector | string scalar
Path to the encryption key file used to sign the shared assembly, specified as a character vector or a string scalar. If the value is empty, the function creates a private assembly. The file path can be relative to the current working directory or absolute.
Example: 'StrongNameKeyFile','sgKey.snk'
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
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.
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 consists
of:
The build type, which is
'dotNETAssembly'
Paths to the following compiled files:
AssemblyName
.dllAssemblyName
Native.dllAssemblyName
_overview.dllGettingStarted.html
A list of included support packages
Build options, specified as a
DotNETAssemblyOptions
object
Limitations
In R2023a: In addition to Windows, this function is supported on Linux® and macOS operating systems.
Version History
Introduced in R2021a
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)