compiler.build.Results - Compiler build results object - MATLAB (original) (raw)

Compiler build results object

Since R2020b

Description

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

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

With MATLAB® Compiler™, you can create standalone applications, Excel® add-ins, or web app archives.

With MATLAB Compiler SDK™, you can create 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.

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:

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 Type	Files
'standaloneApplication'	2×1 cell array {'path\to\ExecutableName.exe'} {'path\to\readme.txt'}
'standaloneWindowsApplication'	3×1 cell array {'path\to\ExecutableName.exe'} {'path\to\splash.png'} {'path\to\readme.txt'}
'webAppArchive'	1×1 cell array {'path\to\ArchiveName.ctf'}
'productionServerArchive'	1×1 cell array {'path\to\ArchiveName.ctf'}
'excelAddIn'	2×1 or 4×1 cell array {'path\to\AddInName_ AddInVersion.dll'} {'path\to\AddInName.bas'} {'path\to\AddInName.xla'} {'path\to\GettingStarted.html'}NoteThe files AddInName.bas and AddInName.xla are included only if you enable the'GenerateVisualBasicFile' option.
'comComponent'	2×1 cell array {'path\to\ComponentName_ ComponentVersion.dll'} {'path\to\GettingStarted.html'}
'cSharedLibrary'	4×1 cell array {'path\to\LibraryName.h'} {'path\to\LibraryName.dll'} {'path\to\LibraryName.lib'} {'path\to\GettingStarted.html'}
'cppSharedLibrary'	2×1 or 4×1 cell arrayUsing the matlab-data interface: {'path\to\v2\'} {'path\to\GettingStarted.html'}Using the mwArray interface: {'path\to\LibraryName.h'} {'path\to\LibraryName.dll'} {'path\to\LibraryName.lib'} {'path\to\GettingStarted.html'}
'dotNETAssembly'	4×1 cell array {'path\to\AssemblyName.dll'} {'path\to\AssemblyName_Native.dll'} {'path\to\_AssemblyName_overview.html'} {'path\to\GettingStarted.html'}
'javaPackage'	3×1 cell array {'path\to\PackageName.jar'} {'path\to\doc\'} {'path\to\GettingStarted.html'}
'pythonPackage'	3×1 cell array {'path\to\example\'} {'path\to\setup.py'} {'path\to\GettingStarted.html'}
'excelClientForProductionServer'	1×1 or 3×1 cell array {'path\to\AddInName.dll'} {'path\to\AddInName.bas'} {'path\to\AddInName.xla'}NoteThe files AddInName.bas and AddInName.xla are included only if you enable the'GenerateVisualBasicFile' option.

Example: {'D:\Documents\MATLAB\work\MagicSquarewebAppproductionServerArchive\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.

This property is read-only.

Runtime dependencies for the generated component, specified as aDependencies object containing two tables,Required and Optional. Each table contains a collection of dependencies.

Examples

collapse all

Create a standalone application and save information about the build type, generated files, included support packages, and build options to acompiler.build.Results object.

Compile using the file magicsquare.m.

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

results =

          BuildType: 'standaloneApplication'
              Files: {2×1 cell}

IncludedSupportPackages: {} Options: [1×1 compiler.build.StandaloneApplicationOptions]
RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

The Files property contains the paths to themagicsquare standalone executable andreadme.txt files.

Create a standalone Windows application 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 Mortgage.mlapp.

results = compiler.build.standaloneWindowsApplication('Mortgage.mlapp')

results =

Results with properties:

          BuildType: 'standaloneWindowsApplication'
              Files: {3×1 cell}

IncludedSupportPackages: {} Options: [1×1 compiler.build.StandaloneApplicationOptions] RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

The Files property contains the paths to the following files:

Mortgage.exe
splash.png
readme.txt

Create a web app archive and save information about the build type, archive file, included support packages, and build options to acompiler.build.Results object.

Compile using the file Mortgage.mlapp.

results = compiler.build.webAppArchive('Mortgage.mlapp')

results =

Results with properties:

          BuildType: 'webAppArchive'
              Files: {'D:\Documents\MATLAB\work\MortgagewebAppArchive\Mortgage.ctf'}

IncludedSupportPackages: {} Options: [1×1 compiler.build.WebAppArchiveOptions] RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

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

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

Compile using the file magicsquare.m.

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]
    RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

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

Create an Excel add-in and save information about the build type, generated files, included support packages, and build options to acompiler.build.Results object.

Compile using the file magicsquare.m.

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

results =

Results with properties:

          BuildType: 'excelAddIn'
              Files: {2×1 cell}

IncludedSupportPackages: {} Options: [1×1 compiler.build.ExcelAddInOptions] RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

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

magicsquare_1_0.dll
GettingStarted.html

Note

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

Create a COM component on a Windows system and save information about the build type, generated files, included support packages, and build options to acompiler.build.Results object.

Compile using the file magicsquare.m.

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

results =

Results with properties:

          BuildType: 'comComponent'
              Files: {2×1 cell}

IncludedSupportPackages: {} Options: [1×1 compiler.build.COMComponentOptions] RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

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

magicsquare_1_0.dll
GettingStarted.html

Create a C library and save information about the build type, compiled files, included support packages, and build options to acompiler.build.Results object.

Compile using the file magicsquare.m.

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

results =

Results with properties:

          BuildType: 'cSharedLibrary'
              Files: {4×1 cell}

IncludedSupportPackages: {} Options: [1×1 compiler.build.CSharedLibraryOptions] RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

The Files property contains the paths to the following files:

magicsquare.dll
magicsquare.lib
magicsquare.h
GettingStarted.html

Create a C++ library and save information about the build type, compiled files, support packages, and build options to a compiler.build.Results object.

Compile using the file magicsquare.m.

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

results =

Results with properties:

          BuildType: 'cppSharedLibrary'
              Files: {2×1 cell}

IncludedSupportPackages: {} Options: [1×1 compiler.build.CppSharedLibraryOptions] RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

The Files property contains the paths to the v2 folder and GettingStarted.html.

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] RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

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

magicsquare.dll
magicsquareNative.dll
magicsquare_overview.dll
GettingStarted.html

Create a Java package and save information about the build type, generated files, included support packages, and build options to acompiler.build.Results object.

Compile using the file magicsquare.m.

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

results =

Results with properties:

          BuildType: 'javaPackage'
              Files: {3×1 cell}

IncludedSupportPackages: {} Options: [1×1 compiler.build.JavaPackageOptions] RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

The Files property contains the paths to the following:

doc folder
magicsquare.jar
GettingStarted.html

Create a Python package and save information about the build type, generated files, included support packages, and build options to acompiler.build.Results object.

Compile using the file magicsquare.m.

results = compiler.build.pythonPackage('magicsquare.m');

results =

Results with properties:

        BuildType: 'pythonPackage'
            Files: {3×1 cell}

IncludedSupportPackages: {} Options: [1×1 compiler.build.PythonPackageOptions] RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

The Files property contains the paths to the following:

example folder
setup.py
GettingStarted.html

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. Save the output as acompiler.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] RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

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 thecompiler.build.excelClientForProductionServer command.

Version History

Introduced in R2020b