Main Content

compiler.build.DotNETAssemblyOptions

Options for building .NET assemblies

Since R2021a

Description

example

opts = compiler.build.DotNETAssemblyOptions(Files) creates a DotNETAssemblyOptions object using MATLAB® functions specified by Files. Use the DotNETAssemblyOptions object as an input to the compiler.build.dotNETAssembly function.

example

opts = compiler.build.DotNETAssemblyOptions(Files,Name,Value) creates a DotNETAssemblyOptions object with options specified using one or more name-value arguments. Options include the class name, output directory, and additional files to include.

example

opts = compiler.build.DotNETAssemblyOptions(ClassMap) creates a DotNETAssemblyOptions object with a class mapping specified using a container.Map object ClassMap.

example

opts = compiler.build.DotNETAssemblyOptions(ClassMap,Name,Value) creates a DotNETAssemblyOptions object with a class mapping specified using ClassMap and options specified using one or more name-value arguments. Options include the assembly name, output directory, and additional files to include.

Examples

collapse all

Create a DotNETAssemblyOptions 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.DotNETAssemblyOptions(appFile)
opts = 

  DotNETAssemblyOptions with properties:

             AssemblyName: 'example.magicsquare'
          AssemblyVersion: '1.0.0.0'
                 ClassMap: [1×1 containers.Map]
               DebugBuild: off
             EmbedArchive: on
           EnableRemoting: off
         FrameworkVersion: '4.0'
    SampleGenerationFiles: {}
        StrongNameKeyFile: ''
          AdditionalFiles: {}s+ AutoDetectDataFiles: ons+ ObfuscateArchive: offs+ SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: '.\magicsquaredotNETAssembly'

   Class Map Information
         magicsquareClass: {'C:\Program Files\MATLAB\R2024a\extern\examples\compiler\magicsquare.m'}

You can modify property values of an existing DotNETAssemblyOptions object using dot notation.

opts.Verbose = 'on'
opts = 

  DotNETAssemblyOptions with properties:

             AssemblyName: 'example.magicsquare'
          AssemblyVersion: '1.0.0.0'
                 ClassMap: [1×1 containers.Map]
               DebugBuild: off
             EmbedArchive: on
           EnableRemoting: off
         FrameworkVersion: '4.0'
    SampleGenerationFiles: {}
        StrongNameKeyFile: ''
          AdditionalFiles: {}s+ AutoDetectDataFiles: ons+ ObfuscateArchive: offs+ SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: '.\magicsquaredotNETAssembly'

   Class Map Information
         magicsquareClass: {'C:\Program Files\MATLAB\R2024a\extern\examples\compiler\magicsquare.m'}

Use the DotNETAssemblyOptions object as an input to the compiler.build.dotNETAssembly function to build a .NET assembly.

buildResults = compiler.build.dotNETAssembly(opts);

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

For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler. Use name-value arguments to specify the output directory and disable automatic detection of data files.

opts = compiler.build.DotNETAssemblyOptions('magicsquare.m',...
    'OutputDir','D:\Documents\MATLAB\work\MagicDotNET',...
    'AutoDetectDataFiles','off')
opts = 

  DotNETAssemblyOptions with properties:

             AssemblyName: 'example.magicsquare'
          AssemblyVersion: '1.0.0.0'
                 ClassMap: [1×1 containers.Map]
               DebugBuild: off
             EmbedArchive: on
           EnableRemoting: off
         FrameworkVersion: '4.0'
    SampleGenerationFiles: {}
        StrongNameKeyFile: ''
          AdditionalFiles: {}
      AutoDetectDataFiles: off
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\MagicDotNET'

   Class Map Information
         magicsquareClass: {'C:\Program Files\MATLAB\R2024a\extern\examples\compiler\magicsquare.m'}

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

opts.Verbose = 'on'
opts = 

  DotNETAssemblyOptions with properties:

             AssemblyName: 'example.magicsquare'
          AssemblyVersion: '1.0.0.0'
                 ClassMap: [1×1 containers.Map]
               DebugBuild: off
             EmbedArchive: on
           EnableRemoting: off
         FrameworkVersion: '4.0'
    SampleGenerationFiles: {}
        StrongNameKeyFile: ''
          AdditionalFiles: {}
      AutoDetectDataFiles: off
          SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\MagicDotNET'

   Class Map Information
         magicsquareClass: {'C:\Program Files\MATLAB\R2024a\extern\examples\compiler\magicsquare.m'}

Use the DotNETAssemblyOptions object as an input to the compiler.build.dotNETAssembly function to build a .NET assembly.

buildResults = compiler.build.dotNETAssembly(opts);

Create a DotNETAssemblyOptions object using a class map.

Create a containers.Map object whose keys are class names and whose values are MATLAB function files.

cmap = containers.Map;
cmap('Class1') = {'exampleFcn1.m','exampleFcn2.m'};
cmap('Class2') = {'exampleFcn3.m','exampleFcn4.m'};

Create the DotNETAssemblyOptions object using the class map cmap.

opts = compiler.build.DotNETAssemblyOptions(cmap)
opts = 

  DotNETAssemblyOptions with properties:

             AssemblyName: 'example.exampleFcn1'
          AssemblyVersion: '1.0.0.0'
                 ClassMap: [2×1 containers.Map]
               DebugBuild: off
             EmbedArchive: on
           EnableRemoting: off
         FrameworkVersion: '4.0'
    SampleGenerationFiles: {}
        StrongNameKeyFile: ''
          AdditionalFiles: {}s+ AutoDetectDataFiles: ons+ ObfuscateArchive: offs+ SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: '.\exampleFcn1dotNETAssembly'

   Class Map Information
                   Class1: {2×1 cell}
                   Class2: {2×1 cell}

You can also create a DotNETAssemblyOptions object using name-value arguments or modify an existing object using dot notation. For this example, specify an output directory, enable verbose output, and disable automatic detection of data files.

opts = compiler.build.DotNETAssemblyOptions(cmap,...
    'OutputDir','D:\Documents\MATLAB\work\MagicDotNET',...
    'Verbose','On');
opts.AutoDetectDataFiles = 'off'
opts = 

  DotNETAssemblyOptions with properties:

             AssemblyName: 'example.exampleFcn1'
          AssemblyVersion: '1.0.0.0'
                 ClassMap: [2×1 containers.Map]
               DebugBuild: off
             EmbedArchive: on
           EnableRemoting: off
         FrameworkVersion: '4.0'
    SampleGenerationFiles: {}
        StrongNameKeyFile: ''
          AdditionalFiles: {}
      AutoDetectDataFiles: off
          SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\MagicDotNET'

   Class Map Information
                   Class1: {2×1 cell}
                   Class2: {2×1 cell}

Use the DotNETAssemblyOptions object as an input to the compiler.build.dotNETAssembly function to build a .NET assembly.

buildResults = compiler.build.dotNETAssembly(opts);

Input Arguments

collapse all

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 a .m extension.

Example: ["myfunc1.m","myfunc2.m"]

Data Types: char | string | cell

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 a .m extension.

Example: cmap

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'

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

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

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

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 .NET assembly.

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

Example: 'AutoDetectDataFiles','off'

Data Types: logical

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

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 the compiled assembly contains debug symbols.

  • If you set this property to 'off', then the compiled assembly does not contain debug symbols.

Example: 'DebugBuild','on'

Data Types: logical

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

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

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

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

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 using mcc 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

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

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

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

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 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

.NET assembly build options, returned as a DotNETAssemblyOptions object.

Version History

Introduced in R2021a