ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
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 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.
[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."<br>
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.) |
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 ⛓
Example usage ⛓
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.
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.