Manpages - MPI_File_delete.3
Table of Contents
NAME
MPI_File_delete - Deletes a file.
SYNTAX
C Syntax
#include <mpi.h> int MPI_File_delete(const char *filename, MPI_Info info)
Fortran Syntax
USE MPI ! or the older form: INCLUDE 'mpif.h' MPI_FILE_DELETE(FILENAME, INFO, IERROR) CHARACTER*(*) FILENAME INTEGER INFO, IERROR
Fortran 2008 Syntax
USE mpi_f08 MPI_File_delete(filename, info, ierror) CHARACTER(LEN=*), INTENT(IN) :: filename TYPE(MPI_Info), INTENT(IN) :: info INTEGER, OPTIONAL, INTENT(OUT) :: ierror
C++ Syntax
#include <mpi.h> static void MPI::File::Delete(const char* filename, const MPI::Info& info)
INPUT PARAMETERS
- filename
- Name of file to delete (string).
- info
- Info object (handle).
OUTPUT PARAMETER
- IERROR
- Fortran only: Error status (integer).
DESCRIPTION
MPI_File_delete deletes the file identified by the file name filename, provided it is not currently open by any process. It is an error to delete the file with MPI_File_delete if some process has it open, but MPI_File_delete does not check this. If the file does not exist, MPI_File_delete returns an error in the class MPI_ERR_NO_SUCH_FILE.
ERRORS
Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI::Exception object.
Before the error value is returned, the current MPI error handler is called. For MPI I/O function errors, the default error handler is set to MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error.