Required

Yes

Languages

C, C++

Syntax

void mdlTerminate(SimStruct *S)

Arguments

Description

This method performs any actions, such as freeing of memory, that must be performed when the simulation is terminated or when an S-Function block is destroyed (e.g., when it is deleted from a model). This method is called at the end of every simulation in Fast Restart mode.

In C MEX S-functions, themdlTerminatemethod is called after a simulation (mdlStartis called).

In addition, if theSS_OPTION_CALL_TERMINATE_ON_EXIToption is set for a given S-function, and ifmdlInitializeSizesis called, then the user is guaranteed that Simulink will callmdlTerminate. One reason to set theSS_OPTION_CALL_TERMINATE_ON_EXIToption is to allocate memory inmdlInitializeSizesrather than wait untilmdlStart.

Note that Simulink callsmdlInitializeSizesunder a number of circumstances, including compilation and simulation. Simulink will also callmdlInitializeSizesduring model editing if you perform an operation such as the setting of parameters.

In C MEX S-functions, use theUNUSED_ARGmacro if themdlTerminatefunction does not perform any actions that require the SimStructSto indicate that theSinput argument is required, but not used in the body of the callback. To do this, insert the line

UNUSED_ARG(S)

after any declarations inmdlTerminate.

#if defined(MATLAB_MEX_FILE) static void mdlTerminate(SimStruct *S) { /* Add mdlTerminate code here * } #endif

Example

Suppose your S-function allocates blocks of memory inmdlStartand saves pointers to the blocks in aPWorkvector. The following code fragment would free this memory.

{ int i; for (i = 0; i
           

See Also

ssSetOptions,Terminate