matlab::engine::connectMATLAB - Connect to shared MATLAB session synchronously - MATLAB (original) (raw)
Main Content
Connect to shared MATLAB session synchronously
Description
std::unique_ptr<MATLABEngine> connectMATLAB()
std::unique_ptr<MATLABEngine> connectMATLAB(const matlab::engine::String& name)
Connect synchronously to a shared MATLAB® session on the local machine.
- If you specify the name of a shared MATLAB session, but the engine cannot find a session with that name, the engine throws an exception.
- If you do not specify a name and there is no shared MATLAB session available, the engine starts a new shared MATLAB session. The MATLAB desktop is not started.
- If you do not specify a name and there are shared MATLAB sessions available, the engine connects to the first available session.
Include
| Namespace: | matlab::engine |
|---|---|
| Include | MatlabEngine.hpp |
Parameters
| const matlab::engine::String& name | Name of the shared MATLAB session |
|---|
Return Value
| std::unique_ptr | Pointer to a MATLABEngine object |
|---|
Exceptions
| matlab::engine::EngineException | Throws exception if function fails to connect to the specified MATLAB session. |
|---|
Examples
Connect to a shared MATLAB session named my_matlab.
std::unique_ptr<MATLABEngine> matlabPtr = connectMATLAB(u"my_matlab");
Version History
Introduced in R2017b