engSetVisible (C)

Show or hide MATLAB engine session

C Syntax

#include "engine.h"
int engSetVisible(Engine *ep, bool value);

Arguments

ep: Engine pointer
value: Value to set the Visible property to. Set value to 1 to make the engine window visible, or to 0 to make it invisible.

Returns

Microsoft Windows Operating System Only

0 on success, and 1 otherwise.

Description

engSetVisible makes the window for the MATLAB^® engine session, ep, either visible or invisible on the Windows^® desktop. You can use this function to enable or disable user interaction with the MATLAB engine session.

Note

The MATLAB Engine API for C++ functions are recommended over engSetVisible. The MATLAB Engine API for C++ includes modern C++ features for writing engine applications. For more information, see Call MATLAB from C++. There are no plans to remove engSetVisible or the Engine API for C.

Examples

This C code opens engine session ep and disables its visibility.

Engine *ep;
bool vis;

ep = engOpen(NULL);
engSetVisible(ep, 0);

To determine the current visibility setting, call:

engGetVisible(ep, &vis);