C Shared Library Integration

Integrate packaged MATLAB^® functions into C applications

MATLAB Compiler SDK™ enables you to create C shared libraries from MATLAB functions.

Shared libraries that use the mxArray API have an interface that uses C-style functions to initialize the MATLAB Runtime, load the packaged MATLAB functions into the MATLAB Runtime, and manage data that is passed between the C code and the MATLAB Runtime. For an example, see Implement a C Shared Library with a Driver Application.

Functions

`compiler.build.cSharedLibrary`	Create C shared library
`compiler.build.CSharedLibraryOptions`	Options for building C shared libraries
`mbuild`	Compile and link source files against MATLAB generated shared libraries

C API

`mclmcrInitialize`	Initialize the MATLAB Runtime proxy library
`mclInitializeApplication`	Set up application state shared by all MATLAB Runtime instances created in current process
`mclTerminateApplication`	Close MATLAB Runtime-internal application state
`<library>Initialize[WithHandlers]`	Initialize MATLAB Runtime instance associated with `library`
`<library>Terminate`	Free all resources allocated by MATLAB Runtime instance associated with `library`
`mclRunMain`	Mechanism for creating identical wrapper code across all platforms
`mclIsMCRInitialized`	Determine if MATLAB Runtime has been properly initialized
`mclWaitForFiguresToDie`	Enable deployed applications to process graphics events so that figure windows remain displayed
`mclGetLastErrorMessage`	Last error message from unsuccessful library initialization or MATLAB function call
`mclGetLogFileName`	Retrieve name of log file used by MATLAB Runtime
`mclIsJVMEnabled`	Determine if MATLAB Runtime was started with instance of Java Virtual Machine (JVM)
`mclIsNoDisplaySet`	Determine if `-nodisplay` mode is enabled

Topics

Create and Implement a C Shared Library

Create a C Shared Library with MATLAB Code
Learn how to create a C shared library.
Create C/C++ Shared Libraries from Command Line
Use the command-line compiler to create C/C++ shared libraries.
Implement a C Shared Library with a Driver Application
Call a C shared library built with MATLAB Compiler SDK from a C driver application.

Integrate a C Shared Library with a C Driver Application

Call a C Shared Library
Use one or more MATLAB Compiler SDK generated C shared libraries in your C application.
Call MATLAB Compiler SDK API Functions from C/C++
Use MATLAB Compiler SDK API functions for C/C++ to assimilate shared libraries in driver code.
Compile and Test a MATLAB Generated C Shared Library
Compile the C driver code and shared libraries, and test the C application.
Use Multiple Shared Libraries in Single Application
Use multiple generated shared libraries in a single C/C++ application.

Mac OS X

Write Applications for macOS
Write deployable C++ applications specifically for macOS.

MATLAB Runtime

Install and Configure MATLAB Runtime
Install, configure, and uninstall MATLAB Runtime.
Set MATLAB Runtime Path for Deployment
Define paths for machines where you want to run applications generated with MATLAB Compiler™ or MATLAB Compiler SDK.
MATLAB Runtime Startup Options
Set MATLAB Runtime options, such as -nojvm, -nodisplay, or -logfile.
MATLAB Runtime Component Cache and Deployable Archive Embedding
Override the default archive embedding behavior, and use MATLAB Runtime component cache.

Troubleshooting C Shared Libraries

Compilation Failures
List of possible failures during compilation.
Testing Failures
List of possible failures during testing .
Deployment Failures
List of possible failures during deployment.