compiler.build.Results

Compiler build results object

Since R2020b

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.

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.

Creation

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

• Create a standalone application using compiler.build.standaloneApplication (example).

• Create a standalone Windows^® application using compiler.build.standaloneWindowsApplication (example).

• Create a web app archive using compiler.build.webAppArchive (example).

• Create an Excel add-in using compiler.build.excelAddIn (example).

If you have a MATLAB Compiler SDK license, you can also create the following objects.

• Create a C shared library using compiler.build.cSharedLibrary (MATLAB Compiler SDK) (example (MATLAB Compiler SDK)).

• Create a C++ shared library using compiler.build.cppSharedLibrary (MATLAB Compiler SDK) (example (MATLAB Compiler SDK)).

• Create a .NET assembly using compiler.build.dotNETAssembly (MATLAB Compiler SDK) (example (MATLAB Compiler SDK)).

• Create a Java package using compiler.build.javaPackage (MATLAB Compiler SDK) (example (MATLAB Compiler SDK)).

• Create a Python package using compiler.build.pythonPackage (MATLAB Compiler SDK) (example (MATLAB Compiler SDK)).

• Create a production server archive using compiler.build.productionServerArchive (MATLAB Compiler SDK) (example (MATLAB Compiler SDK)).

• Create an Excel add-in for MATLAB Production Server using compiler.build.excelClientForProductionServer (MATLAB Compiler SDK) (example (MATLAB Compiler SDK)).

• Create a COM component using compiler.build.comComponent (MATLAB Compiler SDK) (example (MATLAB Compiler SDK)).

Properties

BuildType — Build type

'standaloneApplication' | 'standaloneWindowsApplication' | 'webAppArchive' | 'productionServerArchive' | 'excelAddIn' | 'comComponent' | 'cSharedLibrary' | 'cppSharedLibrary' | 'dotNETAssembly' | 'javaPackage' | 'pythonPackage' | 'excelClientForProductionServer'

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 Function	Build Type
compiler.build.standaloneApplication	'standaloneApplication'
compiler.build.standaloneWindowsApplication	'standaloneWindowsApplication'
compiler.build.webAppArchive	'webAppArchive'
compiler.build.productionServerArchive (MATLAB Compiler SDK)	'productionServerArchive'
compiler.build.excelAddIn	'excelAddIn'
compiler.build.comComponent (MATLAB Compiler SDK)	'comComponent'
compiler.build.cSharedLibrary (MATLAB Compiler SDK)	'cSharedLibrary'
compiler.build.cppSharedLibrary (MATLAB Compiler SDK)	'cppSharedLibrary'
compiler.build.dotNETAssembly (MATLAB Compiler SDK)	'dotNETAssembly'
compiler.build.javaPackage (MATLAB Compiler SDK)	'javaPackage'
compiler.build.pythonPackage (MATLAB Compiler SDK)	'pythonPackage'
compiler.build.excelClientForProductionServer (MATLAB Compiler SDK)	'excelClientForProductionServer'

Data Types: char

Files — Paths to compiled files

cell array of character vectors

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'} Note The 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 array Using 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\AssemblyNameNative.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'} Note The 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

IncludedSupportPackages — Support packages

cell array of character vectors

This property is read-only.

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

Options — Build options

StandaloneApplicationOptions | WebAppArchiveOptions | ProductionServerArchiveOptions | ExcelAddInOptions | COMComponentOptions | CSharedLibraryOptions | CppSharedLibraryOptions | DotNETAssemblyOptions | JavaPackageOptions | PythonPackageOptions | ExcelClientForProductionServerOptions

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 Type	Options
'standaloneApplication'	StandaloneApplicationOptions
'standaloneWindowsApplication'	StandaloneApplicationOptions
'webAppArchive'	WebAppArchiveOptions
'productionServerArchive'	ProductionServerArchiveOptions (MATLAB Compiler SDK)
'excelAddIn'	ExcelAddInOptions
'comComponent'	COMComponentOptions (MATLAB Compiler SDK)
'cSharedLibrary'	CSharedLibraryOptions (MATLAB Compiler SDK)
'cppSharedLibrary'	CppSharedLibraryOptions (MATLAB Compiler SDK)
'dotNETAssembly'	DotNETAssemblyOptions (MATLAB Compiler SDK)
'javaPackage'	JavaPackageOptions (MATLAB Compiler SDK)
'pythonPackage'	PythonPackageOptions (MATLAB Compiler SDK)
'excelClientForProductionServer'	ExcelClientForProductionServerOptions (MATLAB Compiler SDK)

Examples

Get Build Information from Standalone Application

Create a standalone application 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.standaloneApplication('magicsquare.m')

results = 

              BuildType: 'standaloneApplication'
                  Files: {2×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.StandaloneApplicationOptions]

The Files property contains the paths to the magicsquare standalone executable and readme.txt files.

Get Build Information from Standalone Windows Application

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]

The Files property contains the paths to the following files:

• Mortgage.exe

• splash.png

• readme.txt

Get Build Information from Web App Archive

Create a web app 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 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]

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

Get Build Information from Production Server Archive

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.

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.

Get Build Information from Excel Add-In

Create an Excel add-in 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.excelAddIn('magicsquare.m')

results = 

  Results with properties:

              BuildType: 'excelAddIn'
                  Files: {2×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.ExcelAddInOptions]

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

• magicsquare_1_0.dll

• GettingStarted.html

Note

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

Get Build Information from COM Component

Create a COM component 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.comComponent('magicsquare.m')

results = 

  Results with properties:

              BuildType: 'comComponent'
                  Files: {2×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.COMComponentOptions]

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

• magicsquare_1_0.dll

• GettingStarted.html

Get Build Information from C Library

Create a C library and save information about the build type, compiled files, included support packages, and build options to a compiler.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]

The Files property contains the paths to the following files:

• magicsquare.dll

• magicsquare.lib

• magicsquare.h

• GettingStarted.html

Get Build Information from C++ Library

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]

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

Get Build Information from .NET Assembly

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]

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

• magicsquare.dll

• magicsquareNative.dll

• magicsquare_overview.dll

• GettingStarted.html

Get Build Information from Java Package

Create a Java package 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.javaPackage('magicsquare.m')

results = 

  Results with properties:

              BuildType: 'javaPackage'
                  Files: {3×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.JavaPackageOptions]

The Files property contains the paths to the following:

• doc folder

• magicsquare.jar

• GettingStarted.html

Get Build Information from Python Package

Create a Python package 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.pythonPackage('magicsquare.m');

results = 

  Results with properties:

            BuildType: 'pythonPackage'
                Files: {3×1 cell}
IncludedSupportPackages: {}
              Options: [1×1 compiler.build.PythonPackageOptions]

The Files property contains the paths to the following:

• example folder

• setup.py

• GettingStarted.html

Get Build Information from Excel Add-In for MATLAB Production Server

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

Version History

Introduced in R2020b