matlab::engine::findMATLABAsync

Find shared MATLAB sessions asynchronously

Description

FutureResult<std::vector<String>> findMATLABAsync()

Find all shared MATLAB^® sessions on the local machine asynchronously.

You can find MATLAB sessions started with out-of-process mode. For information about mode, see matlab::engine::startMATLABAsync Parameters. If you started a session with in-process mode, the engine throws an exception. (since R2026a)

Include

Namespace:	`matlab::engine`
Include	`MatlabEngine.hpp`

Parameters

None

Return Value

FutureResult<std::vector<String>>

A FutureResult object that you can use to get the names of shared MATLAB sessions on the local machine.

Examples

expand all

Find Shared MATLAB Session Asynchronously

Find the names of all shared MATLAB sessions on the local machine asynchronously. Use the FutureResult get method to retrieve the names.

FutureResult<std::vector<String>> futureNames = findMATLABAsync();
...
std::vector<String> matlabSessions = futureNames.get();

Version History

Introduced in R2017b