onCleanup

Cleanup tasks upon function completion

Syntax

  • cleanupObj = onCleanup(cleanupFun) example

Description

example

cleanupObj = onCleanup(cleanupFun) creates an object that, when destroyed, executes the function cleanupFun. MATLAB® implicitly clears all local variables at the termination of a function, whether by normal completion, or a forced exit, such as an error, or Ctrl+C.

If you reference or pass cleanupObj outside your function, then cleanupFun does not run when that function terminates. Instead, it runs whenever MATLAB destroys the object.

Examples

expand all

Close a Figure After Executing Function

Save the following code in action.m and type action in the Command Window.

function [] = action()
f = figure;
finishup = onCleanup(@() myCleanupFun(f));
disp('Display Figure')
end

function myCleanupFun(f)
close(f)
disp('Close Figure')
end
Display Figure
Close Figure

Switch Directories After Executing Function

Pass your own script to the onCleanup object so that it executes when MATLAB destroys the cleanup object.

Save the following code in cleanup.m.

cd(tempdir)
disp('You are now in the temporary folder')

Save the following code in youraction.m and type youraction in the Command Window.

function [] = youraction
	changeup = onCleanup(@cleanup);
	disp('Execute Code')
end
Execute Code
You are now in the temporary folder

Input Arguments

expand all

cleanupFun — Clean-up taskfunction handle

Clean-up task, specified as a handle to a function.

You can declare any number of onCleanup objects in a program file. However, if the clean-up tasks depend on the order of execution, then you should define only one object that calls a script or function, containing the relevant clean-up commands.

You should use an anonymous function handle to call your clean-up task. This allows you to pass arguments to your clean-up function.

Example: @() fclose('file.m')

Example: @() user_script

Example: @() function(input)

Data Types: function_handle

More About

expand all

Tips

  • Avoid using nested functions during cleanup. MATLAB can clear variables used in nested functions before the clean-up function tries to read from them.

  • If your program contains multiple cleanup objects, MATLAB does not guarantee the order that it destroys these objects.

  • If the order of your cleanup functions matters, define one onCleanup object for all the tasks.

Was this topic helpful?