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

mbuildCompile and link source files against MATLAB generated shared libraries

C API

mclmcrInitializeInitialize the MATLAB Runtime proxy library
mclInitializeApplicationSet up application state shared by all MATLAB Runtime instances created in current process
mclTerminateApplicationClose MATLAB Runtime-internal application state
<library>Initialize[WithHandlers]Initialize MATLAB Runtime instance associated with library
<library>TerminateFree all resources allocated by MATLAB Runtime instance associated with library
mclRunMainMechanism for creating identical wrapper code across all platforms
mclIsMCRInitializedDetermine if MATLAB Runtime has been properly initialized
mclWaitForFiguresToDieEnable deployed applications to process graphics events, enabling figure windows to remain displayed
mclGetLastErrorMessageLast error message from unsuccessful function call
mclGetLogFileNameRetrieve name of log file used by MATLAB Runtime
mclIsJVMEnabledDetermine if MATLAB Runtime was started with instance of Java Virtual Machine (JVM)
mclIsNoDisplaySetDetermine 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 Settings

MATLAB Runtime Path Settings for Development and Testing

Path settings to develop and test applications containing packaged MATLAB code.

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.