Synopsis

int MPI_File_close(MPI_File *fh)

Input/Output Parameters

fh

file handle (handle)

Description

MPI_File_close synchronizes file state and closes the file associated with fh. This call first performs the equivalent of MPI_FILE_SYNC before closing the file. If the file was opened with access mode MPI_MODE_DELETE_ON_CLOSE, the file is deleted. MPI_File_close is a collective routine over the group associated with the file. All outstanding nonblocking requests and split collective operations associated with fh must be completed before calling this routine. Upon completion, the file handle object is deallocated and fh is set to MPI_FILE_NULL.

If the file is deleted on close and other processes are currently accessing the file, the status of the file and the behavior of future accesses by these processes are implementation dependent.

Thread and Interrupt Safety

This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.

Notes for Fortran

All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. 'ierr' is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the 'call' statement.

All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.

Errors

All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with 'MPI_Comm_set_errhandler' (for communicators), 'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but its use is deprecated. The predefined error handler 'MPI_ERRORS_RETURN' may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

  • MPI_SUCCESS - No error; MPI routine completed successfully.

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.