.\" Copyright 2010 Cisco Systems, Inc. All rights reserved. .\" Copyright 2006-2008 Sun Microsystems, Inc. .\" Copyright (c) 1996 Thinking Machines Corporation .TH MPI_File_delete 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#" .SH NAME \fBMPI_File_delete\fP \- Deletes a file. .SH SYNTAX .ft R .nf C Syntax #include int MPI_File_delete(char \fI*filename\fP, MPI_Info \fIinfo\fP) .fi .SH Fortran Syntax .nf INCLUDE 'mpif.h' MPI_FILE_DELETE(\fIFILENAME\fP, \fIINFO\fP, \fIIERROR\fP) CHARACTER*(*) \fIFILENAME\fP INTEGER \fIINFO, IERROR\fP .fi .SH C++ Syntax .nf #include static void MPI::File::Delete(const char* \fIfilename\fP, const MPI::Info& \fIinfo\fP) .fi .SH INPUT PARAMETERS .ft R .TP 1i filename Name of file to delete (string). .TP 1i info Info object (handle). .SH OUTPUT PARAMETER .ft R .TP 1i IERROR Fortran only: Error status (integer). .SH DESCRIPTION .ft R MPI_File_delete deletes the file identified by the file name \fIfilename\fP, 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. .sp .SH 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. .sp 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.