C++ Syntax

bool

MKI_PlugInExit(

bool f_fSaveSettings );

typedef bool

(*MKI_PLUGINEXIT_PTR)(

bool f_fSaveSettings );

This procedure is called when the plug-in is discarded from the application's memory, i.e. when the application closes down. At this time, any allocated memory should be freed.

Parameters

f_fSaveSettings New in Version 2020.2

[bool] If true (normal closing of the application requested by the user), the plug-in's settings shall be saved and then all memory be freed. Otherwise (removing the plug-in directly after loading it, i.e. due to licensing or version problems), only the plug-in's memory shall be freed and the return value will be ignored regardless of the return value.

Return Value

Should return true if the plug-in may be removed from memory. If this procedure returns false, the application will not terminate! However, other plug-ins that previously returned true are already removed and will not be available to the user any more. false should only be returned if removing the plug-in might result in harmful data loss.

Comment

The name of the procedure has to be exactly MKI_PlugInExit. For an example of MKI_PlugInExit, see the Basic Plug-In Code.