Main Content

compiler.build.Results

Compiler build results object

Description

A compiler.build.Results object contains information about the build type, generated files, support packages, and build options of a compiler.build function.

All Results properties are read-only. You can use dot notation to query these properties.

For information on results from compiling standalone applications, Excel® add-ins, or web app archives, see compiler.build.Results (MATLAB Compiler) for MATLAB® Compiler™.

For information on results from compiling C/C++ shared libraries, .NET assemblies, COM components, Java® packages, Python® packages, MATLAB Production Server™ deployable archives, or Excel add-ins for MATLAB Production Server, see compiler.build.Results (MATLAB Compiler SDK) for MATLAB Compiler SDK™.

Creation

There are several ways to create a compiler.build.Results object.

Properties

expand all

This property is read-only.

The build type of the compiler.build function used to generate the results, specified as a character vector:

compiler.build FunctionBuild Type
  
compiler.build.excelClientForProductionServer (MATLAB Compiler SDK)'excelClientForProductionServer'

Data Types: char

This property is read-only.

Paths to the compiled files of the compiler.build function used to generate the results, specified as a cell array of character vectors.

Build TypeFiles
  
  

Example: {'D:\Documents\MATLAB\work\MagicSquareproductionServerArchive\MagicSquare.ctf'}

Data Types: cell

This property is read-only.

Support packages included in the generated component, specified as a cell array of character vectors.

This property is read-only.

Build options of the compiler.build function used to generate the results, specified as an options object of the corresponding build type.

Build TypeOptions
  
  

Examples

collapse all

Create a production server archive and save information about the build type, archive file, included support packages, and build options to a compiler.build.Results object.

Compile using the file magicsquare.m located in matlabroot\extern\examples\compiler.

results = compiler.build.productionServerArchive(magicsquare.m')
results = 

  Results with properties:

                  BuildType: 'productionServerArchive'
                      Files: {'D:\Documents\MATLAB\work\magicsquareproductionServerArchive\magicsquare.ctf'}
    IncludedSupportPackages: {}
                    Options: [1×1 compiler.build.ProductionServerArchiveOptions]

The Files property contains the path to the deployable archive file magicsquare.ctf.

Create an Excel add-in for MATLAB Production Server and save information about the build type, generated files, included support packages, and build options to a compiler.build.Results object.

Build a MATLAB Production Server archive using the file magicsquare.m located in matlabroot\extern\examples\compiler. Save the output as a compiler.build.Results object serverBuildResults.

serverBuildResults = compiler.build.productionServerArchive('magicsquare.m');

Build the Excel add-in using the serverBuildResults object.

results = compiler.build.excelClientForProductionServer(serverBuildResults)
results = 

  Results with properties:

              BuildType: 'excelClientForProductionServer'
                  Files: {1×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.ExcelClientForProductionServerOptions]

The Files property contains the paths to the following compiled files:

  • magicsquare.dll

  • magicsquare.bas

  • magicsquare.xla

Note

The files magicsquare.bas and magicsquare.xla are included in Files only if you enable the 'GenerateVisualBasicFile' option in the compiler.build.excelClientForProductionServer command.

Introduced in R2020b