compiler.build.cSharedLibrary
Syntax
Description
compiler.build.cSharedLibrary(
creates a C shared library using the MATLAB® files specified by FunctionFiles
)FunctionFiles
.
compiler.build.cSharedLibrary(
creates a C shared library with options specified using one or more name-value arguments.
Options include the library name, output directory, and additional files to include.FunctionFiles
,Name,Value
)
compiler.build.cSharedLibrary(
creates a
C shared library with options specified using a
opts
)compiler.build.CSharedLibraryOptions
object opts
.
You cannot specify any other options using name-value arguments.
Examples
Create C Library Using File Input
Create a C shared library using a function file that generates a magic square.
In MATLAB, locate the MATLAB function that you want to deploy as a C shared library. For this example,
use the file magicsquare.m
located in
.matlabroot
\extern\examples\compiler
appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
Build a C library using the compiler.build.cSharedLibrary
command.
compiler.build.cSharedLibrary(appFile);
The build function creates the following files within a folder named
magicsquarecSharedLibrary
in your current working directory:
GettingStarted.html
— File that contains information on integrating your shared library.includedSupportPackages.txt
— Text file that lists all support files included in the library.magicsquare.c
— C source code file.magicsquare.def
— Module-definition file that provides the linker with module information.magicsquare.dll
— Dynamic-link library file.magicsquare.exports
— Exports file that contains all nonstatic function names.magicsquare.h
— C header file.magicsquare.lib
— Import library file.mccExcludedFiles.log
— Log file that contains a list of any toolbox functions that were not included in the application. For information on non-supported functions, see MATLAB Compiler Limitations.readme.txt
— Readme file that contains information on deployment prerequisites and the list of files to package for deployment.requiredMCRProducts.txt
— Text file that contains product IDs of products required by MATLAB Runtime to run the application.unresolvedSymbols.txt
— Text file that contains information on unresolved symbols.
Customize C Library
Create a C library and customize it using name-value arguments.
For this example, use the files flames.m
and
flames.mat
located in
.matlabroot
\extern\examples\compiler
appFile = fullfile(matlabroot,'extern','examples','compiler','flames.m'); MATFile = fullfile(matlabroot,'extern','examples','compiler','flames.mat');
Build a C library using the compiler.build.cSharedLibrary
command. Use name-value arguments to specify the library name, add a MAT-file, and
enable verbose output.
compiler.build.cSharedLibrary(appFile,'LibraryName','MyMagicSquare', ... 'AdditionalFiles',MATFile,'Verbose','on');
Create Multiple Libraries Using Options Object
Create multiple C libraries using a compiler.build.CSharedLibraryOptions
object.
For this example, use the file magicsquare.m
located in
.matlabroot
\extern\examples\compiler
appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
Create a CSharedLibraryOptions
object using
appFile
. Use name-value arguments to specify a common output
directory, disable automatic detection of data files, and enable verbose output.
opts = compiler.build.CSharedLibraryOptions(appFile, ... 'OutputDir','D:\Documents\MATLAB\work\CLibraryBatch', ... 'AutoDetectDataFiles','off', ... 'Verbose','on')
opts =
CSharedLibraryOptions with properties:
EmbedArchive: on
LibraryVersion: '1.0.0.0'
FunctionFiles: {'C:\Program Files\MATLAB\R2024b\extern\examples\compiler\magicsquare.m'}
DebugBuild: off
LibraryName: 'magicsquare'
AdditionalFiles: {}
AutoDetectDataFiles: off
ExternalEncryptionKey: [0×0 struct]
ObfuscateArchive: off
SecretsManifest: ''
SupportPackages: {'autodetect'}
Verbose: on
OutputDir: 'D:\Documents\MATLAB\work\CLibraryBatch'
Build the C shared library using the CSharedLibraryOptions
object.
compiler.build.cSharedLibrary(opts);
To compile using the function file myMagic2.m
with the same
options, use dot notation to modify the FunctionFiles
argument of the
existing cSharedLibrary
object before running the build function
again.
opts.FunctionFiles = 'myMagic2.m';
compiler.build.cSharedLibrary(opts);
By modifying the FunctionFiles
argument and recompiling, you can
compile multiple libraries using the same options object.
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
Input Arguments
FunctionFiles
— 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
opts
— C library build options
compiler.build.CSharedLibraryOptions
object
C library build options, specified as a compiler.build.CSharedLibraryOptions
object.
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: 'Verbose','on'
AdditionalFiles
— Additional files
character vector | string scalar | cell array of character vectors | string array
Additional files and folders to include in the C shared library, 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 asload
andfopen
) are automatically included in the shared library.If you set this property to
'off'
, then you must add data files to the shared library using theAdditionalFiles
option.
Example: 'AutoDetectDataFiles','off'
Data Types: logical
DebugBuild
— Flag to enable debug symbols
'off'
(default) | on/off logical value
Flag to enable 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 causesmbuild
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 shared library.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 UUIDplhs[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
LibraryName
— Name of C shared library
character vector | string scalar
Name of the C shared library, specified as a character vector or a string
scalar. The default name of the generated library is the first entry of the
FunctionFiles
argument.
Example: 'LibraryName','mymagic'
Data Types: char
| string
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 usingmcc
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 library name appended with
cSharedLibrary
.
Example: 'OutputDir','D:\Documents\MATLAB\work\mymagiccSharedLibrary'
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
.
Modify this file by specifying the secret key names in the Embedded field.<component_name>
_secrets_manifest.json
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
results
— Build results
compiler.build.Results
object
Build results, returned as a compiler.build.Results
object. The Results
object contains:
The build type, which is
'cSharedLibrary'
Paths to the following compiled files:
LibraryName
.dllLibraryName
.libLibraryName
.hGettingStarted.html
A list of included support packages
Build options, specified as a
CSharedLibraryOptions
object
Version History
Introduced in R2021a
Comando de MATLAB
Ha hecho clic en un enlace que corresponde a este comando de MATLAB:
Ejecute el comando introduciéndolo en la ventana de comandos de MATLAB. Los navegadores web no admiten comandos de MATLAB.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)