rmfile.m File Reference

Go to the source code of this file.

Functions
function	rmfile (in file, in desc)
	Return a scalar MATLAB logical that is true if and only if the deletion of the input file fails, otherwise, return false. More...

Function Documentation

rmfile()

function rmfile	(	in	file,
		in	desc
	)

Return a scalar MATLAB logical that is true if and only if the deletion of the input file fails, otherwise, return false.

This function is a simple wrapper around the MATLAB function delete().
It is primarily meant to bring consistency to messaging file deletions if they fail.
Such consistency is particularly required on Windows systems as the OS tends to lock file ownership to one application causing deletions to fail frequently.

Parameters

[in]	file	: The input scalar MATLAB string, containing the file path to be deleted.
[in]	desc	: The input scalar MATLAB string, containing a descriptive message to be printed on the MATLAB command line if the deletion task fails. The input desc, if not empty, will be added to the following template before being displayed: "Failed to delete <desc> from the local disk. File may be protected." If the input desc is empty [] or empty string "", a default value "the requested file" for desc will be added to the template. (optional. If missing, no warning will be displayed upon failure.)

Returns

failed : The output scalar MATLAB logical that is true if and only if the deletion of the input file fails, otherwise, return false.

Possible calling interfaces ⛓

failed = pm.sys.path.rmfile(file)
failed = pm.sys.path.rmfile(file, desc)

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../../'); % Add the ParaMonte library root directory to the search path.
 
pm.matlab.show()
pm.matlab.show("fid = fopen('temp.temp', 'w'); fclose(fid);")
                fid = fopen('temp.temp', 'w'); fclose(fid);
 
pm.matlab.show()
pm.matlab.show('pm.sys.path.list()')
pm.matlab.show( pm.sys.path.list() )
 
pm.matlab.show()
pm.matlab.show('pm.sys.path.rmfile("temp.temp")')
pm.matlab.show( pm.sys.path.rmfile("temp.temp") )
 
pm.matlab.show()
pm.matlab.show('pm.sys.path.rmfile("temp.temp")')
pm.matlab.show( pm.sys.path.rmfile("temp.temp") )
 
pm.matlab.show()
pm.matlab.show('pm.sys.path.rmfile("temp.temp", "Temp file is missing.")')
pm.matlab.show( pm.sys.path.rmfile("temp.temp", "Temp file is missing.") )
 
pm.matlab.show()
pm.matlab.show('pm.sys.path.list()')
pm.matlab.show( pm.sys.path.list() )

Example output ⛓

 
fid = fopen('temp.temp', 'w'); fclose(fid);
 
pm.sys.path.list()
    "main.m"
    "main.out.m"
    "temp.temp"
 
pm.sys.path.rmfile("temp.temp")
   0
 
pm.sys.path.rmfile("temp.temp")
   0
 
pm.sys.path.rmfile("temp.temp", "Temp file is missing.")
   0
 
pm.sys.path.list()
    "main.m"
    "main.out.m"

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Joshua Alexander Osborne, May 21 2024, 5:28 AM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin