This is machine translation

Translated by

Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

MATLAB Engine API for C++

Run MATLAB^® code from C++ programs, with object oriented programming support and asynchronous execution

The MATLAB Engine API for C++ provides an interface between the C++ programming language and MATLAB. This API enables C++ programs to launch MATLAB, evaluate MATLAB functions with arguments, and exchange data between MATLAB and C++ programs.

The MATLAB Engine API for C++ supports the MATLAB Data API, which provides a way for applications running outside of MATLAB to work with MATLAB data through a MATLAB-neutral interface. For more information on the MATLAB Data API, see MATLAB Data API.

Share MATLAB Session

matlab.engine.shareEngine Convert running MATLAB session to shared session

Start, Find, Connect, and Terminate MATLAB

`matlab::engine::connectMATLAB`	Connect to shared MATLAB session synchronously
`matlab::engine::connectMATLABAsync`	Connect to shared MATLAB session asynchronously
`matlab::engine::findMATLAB`	Find shared MATLAB sessions synchronously
`matlab::engine::findMATLABAsync`	Find shared MATLAB sessions asynchronously
`matlab::engine::startMATLAB`	Start MATLAB synchronously
`matlab::engine::startMATLABAsync`	Start MATLAB asynchronously
`matlab::engine::terminateEngineClient`	Free engine resources during runtime

Type Conversions

`matlab::engine::convertUTF8StringToUTF16String`	Convert UTF-8 string to UTF-16 string
`matlab::engine::convertUTF16StringToUTF8String`	Convert UTF-16 string to UTF-8 string

Type Definitions

`matlab::engine::StreamBuffer`	Define stream buffer
`matlab::engine::String`	Define UTF16 string

Classes

`matlab::engine::MATLABEngine`	Evaluate MATLAB functions from C++ program
`matlab::engine::FutureResult`	Retrieve result from asynchronous operation
`matlab::engine::SharedFutureResult`	Retrieve result from asynchronous operation as shared future
`matlab::engine::WorkspaceType`	Type of MATLAB workspace

Topics

Setup and Build Engine Applications

Introduction to Engine API for C++

Introduction to the basic design of a C++ engine program.

Build C++ Engine Programs

Build engine applications on different platforms.

Test Your Build Environment

Use this sample code to confirm your development environment for the MATLAB Engine API for C++.

C++ Engine API

The MATLAB Engine C++ API comprises functions, classes, and typedefs in matlab::engine namespace.

Start and Connect to MATLAB

Start MATLAB Sessions from C++

Start and connect to a MATLAB session synchronously and asynchronously from C++.

Connect C++ to Running MATLAB Session

Connect the C++ engine to a MATLAB session that has been started as or converted to a shared session.

Call Functions and Exchange Data

Call MATLAB Functions from C++

Call MATLAB functions from C++, passing variable to MATLAB and returning variables to C++.

Evaluate MATLAB Statements from C++

Evaluate MATLAB expression from C++ and write variables into the MATLAB base workspace.

Pass Variables from C++ to MATLAB

Pass variables from C++ to MATLAB as function arguments or by placing those variables directly in the MATLAB base workspace.

Pass Variables from MATLAB to C++

Get variables from the MATLAB base or global workspace.

Redirect MATLAB Command Window Output to C++

Redirect MATLAB command window output, including error messages, to you C++ program.

Run Simulink Simulation from C++

Run Simulink^® model simulations from C++ and visualize the results with MATLAB graphics.

Convert C++ Engine Application to MATLAB Compiler SDK Application

How to convert an engine application to a deployed application using MATLAB Compiler SDK™.

Create MATLAB Data Types

Create Structure Arrays from C++

Create a structure array in C++ and pass it to MATLABor get a structure array defined in MATLAB.

Create Cell Arrays from C++

Create heterogeneous arrays in C++ to use as MATLAB cell arrays.

Pass Enumerations to MATLAB From C++

Pass enumeration members of MATLAB enumeration classes to MATLAB from C++.

Pass Sparse Arrays to MATLAB From C++

Pass arrays to MATLAB as MATLAB sparse arrays.

Related Information

MATLAB Engine API for C