compiler.build.ExcelAddInOptions

构建 Excel 加载项的选项

自 R2021a 起

语法

opts = compiler.build.ExcelAddInOptions(FunctionFiles)

opts = compiler.build.ExcelAddInOptions(FunctionFiles,Name,Value)

说明

opts = compiler.build.ExcelAddInOptions(FunctionFiles) 使用 FunctionFiles 指定的 MATLAB^® 函数创建一个 ExcelAddInOptions 对象。使用 ExcelAddInOptions 对象作为 compiler.build.excelAddIn 函数的输入。

示例

opts = compiler.build.ExcelAddInOptions(FunctionFiles,Name,Value) 使用一个或多个名称值参量指定选项来创建一个 ExcelAddInOptions 对象。选项包括加载项名称、要包含的附加文件和输出目录。

示例

全部折叠

创建 Excel 加载项选项对象

使用文件输入创建 ExcelAddInOptions 对象。

对于此示例，使用位于 matlabroot\extern\examples\compiler 文件 magicsquare.m。

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
opts = compiler.build.ExcelAddInOptions(appFile)

opts = 

  ExcelAddInOptions with properties:

                  AddInName: 'magicsquare'
               AddInVersion: '1.0.0.0'
                  ClassName: 'magicsquareClass'
                 DebugBuild: off
               EmbedArchive: on
              FunctionFiles: {'C:\Program Files\MATLAB\R2024b\extern\examples\compiler\magicsquare.m'}
    GenerateVisualBasicFile: off
            AdditionalFiles: {}
        AutoDetectDataFiles: on
      ExternalEncryptionKey: [0×0 struct]
           ObfuscateArchive: off
            SecretsManifest: ''
            SupportPackages: {'autodetect'}
                    Verbose: off
                  OutputDir: '.\magicsquareexcelAddIn'

您可以使用点符号修改现有 ExcelAddInOptions 对象的属性值。例如，启用详尽输出。

opts.Verbose = 'on'

opts = 

  ExcelAddInOptions with properties:

                  AddInName: 'magicsquare'
               AddInVersion: '1.0.0.0'
                  ClassName: 'magicsquareClass'
                 DebugBuild: off
               EmbedArchive: on
              FunctionFiles: {'C:\Program Files\MATLAB\R2024b\extern\examples\compiler\magicsquare.m'}
    GenerateVisualBasicFile: off
            AdditionalFiles: {}
        AutoDetectDataFiles: on
      ExternalEncryptionKey: [0×0 struct]
           ObfuscateArchive: off
            SecretsManifest: ''
            SupportPackages: {'autodetect'}
                    Verbose: on
                  OutputDir: '.\magicsquareexcelAddIn'

使用 ExcelAddInOptions 对象作为 compiler.build.excelAddIn 函数的输入来构建 Excel^® 加载项。

buildResults = compiler.build.excelAddIn(opts);

自定义 Excel 加载项选项对象

创建一个 ExcelAddInOptions 对象并使用名称值参量对其进行自定义。

对于此示例，使用位于 matlabroot\extern\examples\compiler 文件 magicsquare.m。使用名称-值参量指定输出目录，生成 Visual Basic^® 文件并启用详尽输出。

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
opts = compiler.build.ExcelAddInOptions(appFile, ...
'OutputDir','D:\Documents\MATLAB\work\MagicSquareAddIn', ...
'GenerateVisualBasicFile','On')

使用 ExcelAddInOptions 对象作为 compiler.build.excelAddIn 函数的输入来构建 Excel 加载项。

buildResults = compiler.build.excelAddIn(opts);

输入参数

全部折叠

`FunctionFiles` — MATLAB 函数文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

实现 MATLAB 函数的文件列表，指定为字符向量、字符串标量、字符串数组或字符向量元胞数组。文件必须具有以下扩展名之一：.m、.p、.mlx 或 .mexa64。

示例: {'myFunction1.m','myFunction2.m'}

数据类型: char | string | cell

名称-值参数

全部折叠

以 Name1=Value1,...,NameN=ValueN 的形式指定可选参量对组，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但对各个参量对组的顺序没有要求。

如果使用的是 R2021a 之前的版本，请使用逗号分隔每个名称和值，并用引号将 Name 引起来。

示例: 'Verbose','on'

`AddInName` — Excel 加载项的名称
字符向量 | 字符串标量

Excel 加载项的名称，指定为字符向量或字符串标量。生成的加载项的默认名称是 FunctionFiles 参量的第一个条目。名称必须以字母开头，并且只能包含字母和下划线。

示例: 'AddInName','myAddIn'

数据类型: char | string

`AddInVersion` — 加载项版本
`'1.0.0.0'` (默认) | 字符向量 | 字符串标量

加载项版本，指定为字符向量或字符串标量。

示例: 'AddInVersion','4.0'

数据类型: char | string

`AdditionalFiles` — 其他文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

Excel 加载项中包含的附加文件和文件夹，指定为字符向量、字符串标量、字符串数组或字符向量元胞数组。路径可以是相对于当前工作目录的路径，也可以是绝对路径。

示例: 'AdditionalFiles',["myvars.mat","data.txt"]

数据类型: char | string | cell

`AutoDetectDataFiles` — 自动包含数据文件的标志
`'on'` (默认) | on/off 逻辑值

标志自动包含数据文件，指定为 'on' 或 'off'，或者指定为数字或逻辑值 1 (true) 或 0 (false)。值 'on' 等效 true，而 'off' 等效 false。因此，您可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的开/关逻辑值。

如果将此属性设置为 'on'，则您作为某些函数（例如 load 和 fopen）的输入提供的数据文件将自动包含在加载项中。
如果将此属性设置为 'off'，则必须使用 AdditionalFiles 属性将数据文件添加到加载项。

示例: 'AutoDetectDataFiles','Off'

数据类型: logical

`ClassName` — 类的名称
字符向量 | 字符串标量

类的名称，指定为字符向量或字符串标量。类名必须符合 Excel 加载项类名要求。

默认值是 FunctionFiles 参量中列出的第一个文件的名称加上 Class。

示例: 'ClassName','magicsquareClass'

数据类型: char | string

`DebugBuild` — 启用调试符号的标志
`'off'` (默认) | on/off 逻辑值

启用调试符号的标志，指定为 'on' 或 'off'，或者指定为数字或逻辑值 1 (true) 或 0 (false)。值 'on' 等效 true，而 'off' 等效 false。因此，您可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的开/关逻辑值。

如果将此属性设置为 'on'，则调试符号信息将包含在编译的工件中。此选项还会使 mbuild 将相应的调试标志传递到系统编译器。通过调试选项，您可以回溯到可以确定故障是发生在 MATLAB Runtime 的初始化、函数调用还是终止例程中的点。此选项不允许您使用外部调试器调试 MATLAB 文件。
如果将此属性设置为 'off'，则不包括调试符号。这是默认选项。

示例: 'DebugSymbols','on'

数据类型: logical

`EmbedArchive` — 嵌入可部署存档的标志
`'on'` (默认) | on/off 逻辑值

嵌入可部署存档的标志，指定为 'on' 或 'off'，或者指定为数字或逻辑值 1 (true) 或 0 (false)。值 'on' 等效 true，而 'off' 等效 false。因此，您可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的开/关逻辑值。

如果将此属性设置为 'on'，则该函数会将可部署存档嵌入到 Excel 加载项中。
如果将此属性设置为 'off'，则该函数会将可部署存档生成为单独的文件。

示例: 'EmbedArchive','Off'

数据类型: logical

`ExternalEncryptionKey` — 加密密钥和加载程序文件路径
标量结构体

自 R2024b 起

外部 AES 加密密钥和 MEX 密钥加载程序文件的路径，指定为标量结构，具有恰好两行字符向量或字符串标量字段，分别名为 EncryptionKeyFile 和 RuntimeKeyLoaderFile。两个结构体字段都是必需的。文件路径可以是相对于当前工作目录的路径，也可以是绝对路径。

例如，使用 struct keyValueStruct 将加密密钥指定为 encrypt.key 并将加载程序文件指定为 loader.mexw64。

keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'

加密密钥文件必须采用以下受支持的格式之一：

二进制 256 位 AES 密钥，文件大小为 32 字节
十六进制编码的 AES 密钥，文件大小为 64 字节

MEX 文件加载程序在运行时检索解密密钥，并且必须是具有以下参量的接口：

prhs[0] - 输入，指定为静态值 'get' 的字符数组
prhs[1] - 输入，指定为 CTF 组件 UUID 的字符数组
plhs[0] - 输出，32 字节 UINT8 数字数组或 64 字节十六进制编码字符数组，具体取决于密钥格式

请勿在多个 CTF 之间共享同一个密钥。

示例: 'ExternalEncryptionKey',keyValueStruct

数据类型: struct

`GenerateVisualBasicFile` — 生成 Visual Basic 文件的标志
`'off'` (默认) | on/off 逻辑值

用于生成 Visual Basic 文件 (.bas) 和 Excel 加载项文件 (.xla) 的标志，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效 true，而 'off' 等效 false。因此，您可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的开/关逻辑值。

如果将此属性设置为 'on'，则该函数将生成一个 Excel 加载项 XLA 文件和一个 Visual Basic BAS 文件，其中包含加载项的 Microsoft^® Excel 公式函数接口。
如果将此属性设置为 'off'，则该函数不会生成 Visual Basic 文件或 Excel 加载项文件。

注意

要生成 Excel 加载项文件 (.xla)，您必须启用 Excel 设置中的“信任对 VBA 工程对象模型的访问”。

示例: 'GenerateVisualBasicFile','on'

数据类型: logical

`ObfuscateArchive` — 混淆处理可部署存档的标志
`'off'` (默认) | on/off 逻辑值

用于混淆处理可部署存档的标志，指定为 'on' 或 'off'，或者指定为数字或逻辑值 1 (true) 或 0 (false)。值 'on' 等效 true，而 'off' 等效 false。因此，您可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的开/关逻辑值。

如果将此属性设置为 'on'，则可部署存档中的文件夹结构和文件名将对最终用户进行混淆，并且 MATLAB 文件中包含的用户代码和数据将放入存档内的用户包中。此外，所有 .m 文件在打包之前都会转换为 P 文件。此选项等效使用指定 -j 和 -s 的 mcc。
如果将此属性设置为 'off'，则可部署存档不会被混淆。这是默认行为。

示例: 'ObfuscateArchive','on'

数据类型: logical

`OutputDir` — 输出目录路径
字符向量 | 字符串标量

保存构建文件的输出目录的路径，指定为字符向量或字符串标量。该路径可以是相对于当前工作目录的路径，也可以是绝对路径。

构建文件夹的默认名称是加载项名称加上 excelAddIn。

示例: 'OutputDir','D:\Documents\MATLAB\work\mymagicexcelAddIn'

数据类型: char | string

`SecretsManifest` — JSON 清单文件路径
字符向量 | 字符串标量

自 R2024b 起

机密清单 JSON 文件的路径，该文件指定要嵌入可部署存档中的机密密钥，指定为字符向量或字符串标量。该路径可以是相对于当前工作目录的路径，也可以是绝对路径。

如果您的 MATLAB 代码调用 getSecret、getSecretMetadata 或 isSecret 函数，您必须在 JSON 机密清单文件中指定要嵌入可部署存档的密钥。如果您的代码调用 getSecret 并且您未指定 SecretsManifest 选项，MATLAB Compiler™ 会发出警告并在名为 <component_name>_secrets_manifest.json 的输出文件夹中生成一个模板 JSON 文件。通过在嵌入字段中指定密钥名称来修改此文件。

setSecret 函数不可部署。要将机密嵌入可部署存档中，您必须在构建存档之前在 MATLAB 中调用 setSecret。

有关使用密钥进行部署的更多信息，请参阅处理已部署应用程序中的敏感信息。

示例: 'SecretsManifest','D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'

数据类型: char | string

`SupportPackages` — 支持包
`'autodetect'` (默认) | `'none'` | 字符串标量 | 字符向量元胞数组 | 字符串数组

要包含的支持包，指定为以下选项之一：

'autodetect'（默认）- 依赖关系分析过程会自动检测并包含所需的支持包。
'none' - 不包括任何支持包。使用此选项可能会导致运行时错误。
字符串标量、字符向量或字符向量元胞数组- 仅包含指定的支持包。要列出已安装的支持包或特定文件使用的支持包，请参阅 compiler.codetools.deployableSupportPackages。

示例: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

数据类型: char | string | cell

`Verbose` — 控制编译详细程度的标志
`'off'` (默认) | on/off 逻辑值

用于控制构建详细程度的标志，指定为 'on' 或 'off'，或者指定为数字或逻辑值 1 (true) 或 0 (false)。值 'on' 等效 true，而 'off' 等效 false。因此，您可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的开/关逻辑值。

如果将此属性设置为 'on'，则 MATLAB 命令行窗口将显示进度信息，指示构建过程中的编译器输出。
如果将此属性设置为 'off'，则命令行窗口不会显示进度信息。

示例: 'Verbose','on'

数据类型: logical

输出参量

全部折叠

`opts` — Excel 加载项编译选项
`ExcelAddInOptions` 对象

Excel 加载项构建选项，作为 ExcelAddInOptions 对象返回。

版本历史记录

在 R2021a 中推出

另请参阅

compiler.build.excelAddIn | mcc

compiler.build.ExcelAddInOptions

语法

说明

示例

创建 Excel 加载项选项对象

自定义 Excel 加载项选项对象

输入参数

FunctionFiles — MATLAB 函数文件 字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

名称-值参数

AddInName — Excel 加载项的名称 字符向量 | 字符串标量

AddInVersion — 加载项版本 '1.0.0.0' (默认) | 字符向量 | 字符串标量

AdditionalFiles — 其他文件 字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

AutoDetectDataFiles — 自动包含数据文件的标志 'on' (默认) | on/off 逻辑值

ClassName — 类的名称 字符向量 | 字符串标量

DebugBuild — 启用调试符号的标志 'off' (默认) | on/off 逻辑值

EmbedArchive — 嵌入可部署存档的标志 'on' (默认) | on/off 逻辑值

ExternalEncryptionKey — 加密密钥和加载程序文件路径 标量结构体

GenerateVisualBasicFile — 生成 Visual Basic 文件的标志 'off' (默认) | on/off 逻辑值

ObfuscateArchive — 混淆处理可部署存档的标志 'off' (默认) | on/off 逻辑值

OutputDir — 输出目录路径 字符向量 | 字符串标量

SecretsManifest — JSON 清单文件路径 字符向量 | 字符串标量

SupportPackages — 支持包 'autodetect' (默认) | 'none' | 字符串标量 | 字符向量元胞数组 | 字符串数组

Verbose — 控制编译详细程度的标志 'off' (默认) | on/off 逻辑值

输出参量

opts — Excel 加载项编译选项 ExcelAddInOptions 对象

版本历史记录

另请参阅

`FunctionFiles` — MATLAB 函数文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

`AddInName` — Excel 加载项的名称
字符向量 | 字符串标量

`AddInVersion` — 加载项版本
`'1.0.0.0'` (默认) | 字符向量 | 字符串标量

`AdditionalFiles` — 其他文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

`AutoDetectDataFiles` — 自动包含数据文件的标志
`'on'` (默认) | on/off 逻辑值

`ClassName` — 类的名称
字符向量 | 字符串标量

`DebugBuild` — 启用调试符号的标志
`'off'` (默认) | on/off 逻辑值

`EmbedArchive` — 嵌入可部署存档的标志
`'on'` (默认) | on/off 逻辑值

`ExternalEncryptionKey` — 加密密钥和加载程序文件路径
标量结构体

`GenerateVisualBasicFile` — 生成 Visual Basic 文件的标志
`'off'` (默认) | on/off 逻辑值

`ObfuscateArchive` — 混淆处理可部署存档的标志
`'off'` (默认) | on/off 逻辑值

`OutputDir` — 输出目录路径
字符向量 | 字符串标量

`SecretsManifest` — JSON 清单文件路径
字符向量 | 字符串标量

`SupportPackages` — 支持包
`'autodetect'` (默认) | `'none'` | 字符串标量 | 字符向量元胞数组 | 字符串数组

`Verbose` — 控制编译详细程度的标志
`'off'` (默认) | on/off 逻辑值

`opts` — Excel 加载项编译选项
`ExcelAddInOptions` 对象