engGetVisible (C)

Determine visibility of MATLAB engine session

C Syntax

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

Arguments

ep: Engine pointer
value: Pointer to value returned from engGetVisible

Returns

Microsoft Windows Operating System Only

0 on success, and 1 otherwise.

Description

engGetVisible returns the current visibility setting for MATLAB^® engine session, ep. A visible engine session runs in a window on the Windows^® desktop, thus making the engine available for user interaction. MATLAB removes an invisible session from the desktop.

Note

The MATLAB Engine API for C++ functions are recommended over engGetVisible. 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 engGetVisible 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);