compiler.build.COMComponentOptions

Options for building COM components

Since R2021a

Syntax

opts = compiler.build.COMComponentOptions(Files)

opts = compiler.build.COMComponentOptions(Files,Name,Value)

opts = compiler.build.COMComponentOptions(ClassMap)

opts = compiler.build.COMComponentOptions(ClassMap,Name,Value)

Description

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

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

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

opts = compiler.build.COMComponentOptions(ClassMap,Name,Value) creates a COMComponentOptions object with a class mapping specified using ClassMap and options specified using one or more name-value arguments.

Examples

Create COM Component Options Object Using File

Create a COMComponentOptions object on a Windows^® system 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.COMComponentOptions(appFile)

opts =

  COMComponentOptions with properties:

                 ClassMap: [1×1 containers.Map]
            ComponentName: 'magicsquare'
         ComponentVersion: '1.0.0.0'
               DebugBuild: off
             EmbedArchive: on
          AdditionalFiles: {}
      AutoDetectDataFiles: on
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: '.\magicsquarecomComponent'

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

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

opts.Verbose = 'on';

Use the COMComponentOptions object as an input to the compiler.build.comComponent function to build a COM component.

buildResults = compiler.build.comComponent(opts);

Customize COM Component Options Object

Create a COMComponentOptions object on a Windows system and customize it using name-value arguments.

For this example, use the file magicsquare.m. Use name-value arguments to specify the output directory and disable the automatic detection of data files.

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

opts =

  COMComponentOptions with properties:

                 ClassMap: [1×1 containers.Map]
            ComponentName: 'magicsquare'
         ComponentVersion: '1.0.0.0'
               DebugBuild: off
             EmbedArchive: on
          AdditionalFiles: {}
      AutoDetectDataFiles: off
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\MagicCOMComponent'

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

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

opts.Verbose = 'on';

Use the COMComponentOptions object as an input to the compiler.build.comComponent function.

buildResults = compiler.build.comComponent(opts);

Create COM Component Options Object Using Class Map

Create a COMComponentOptions object on a Windows system 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 COMComponentOptions object using the class map cmap.

opts = compiler.build.COMComponentOptions(cmap)

opts =

  COMComponentOptions with properties:

            ClassMap: [2×1 containers.Map]
          ComponentName: 'exampleFcn1'
       ComponentVersion: '1.0.0.0'
               DebugBuild: off
             EmbedArchive: on
          AdditionalFiles: {}
      AutoDetectDataFiles: off
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: '.\exampleFcn1comComponent'

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

To customize the COM component, create a new COMComponentOptions object using name-value arguments or modify an existing object using dot notation. For example, specify an output directory, enable verbose output, and disable automatic detection of data files.

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

opts =

  COMComponentOptions with properties:

            ClassMap: [2×1 containers.Map]
          ComponentName: 'exampleFcn1'
       ComponentVersion: '1.0.0.0'
               DebugBuild: off
             EmbedArchive: on
          AdditionalFiles: {}
      AutoDetectDataFiles: off
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\MagicCOMComponent'

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

Use the COMComponentOptions object as an input to the compiler.build.comComponent function to build the COM component.

buildResults = compiler.build.comComponent(opts);

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

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: 'EmbedArchive','on'

AdditionalFiles — Additional files

character vector | string scalar | cell array of character vectors | string array

Additional files and folders to include in the COM component, 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

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 as load and fopen) are automatically included in the COM component.

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

Example: 'AutoDetectDataFiles','off'

Data Types: logical

ClassName — Name of COM class

character vector | string scalar

Name of the COM class, specified as a character vector or a string scalar. You cannot specify this option if you use a ClassMap input. Class names must match the COM 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

ComponentName — Name of COM component

character vector | string scalar

Name of the COM component, specified as a character vector or a string scalar. The value acts as the program ID that is entered into the Windows Registry. The default name of the generated component is the first entry of the Files argument. The name must begin with a letter and contain only alphabetic characters and periods.

Example: 'ComponentName','mycomponent'

Data Types: char | string

ComponentVersion — Component version

'1.0.0.0' (default) | character vector | string scalar

Component version, specified as a character vector or a string scalar. For information on versioning using MATLAB Compiler SDK™, see Versioning.

Example: 'ComponentVersion','4.0'

Data Types: char | string

DebugBuild — Flag to enable debug symbols

'off' (default) | on/off logical value

Flag to include 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 causes mbuild 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 COM component.

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

Example: 'EmbedArchive','off'

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 UUID

• plhs[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 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

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 component name appended with comComponent.

Example: 'OutputDir','D:\Documents\MATLAB\work\mycomponentcomComponent'

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 <component_name>_secrets_manifest.json. Modify this file by specifying the secret key names in the Embedded field.

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

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

opts — COM component build options

COMComponentOptions object

COM component build options, returned as a COMComponentOptions object.

Version History

Introduced in R2021a