source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_File_delete.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files

File size: 1.9 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_File_delete 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_File_delete\fP \- Deletes a file.
6
7.SH SYNTAX
8.ft R
9.nf
10C Syntax
11    #include <mpi.h>
12    int MPI_File_delete(char \fI*filename\fP, MPI_Info \fIinfo\fP)
13
14Fortran Syntax
15    INCLUDE 'mpif.h'
16    MPI_FILE_DELETE(\fIFILENAME\fP, \fIINFO\fP, \fIIERROR\fP)
17         CHARACTER*(*) \fIFILENAME\fP
18         INTEGER \fIINFO, IERROR\fP
19
20.SH C++ Syntax
21.nf
22#include <mpi.h>
23static void MPI::File::Delete(const char* \fIfilename\fP, const
24        MPI::Info& \fIinfo\fP)
25
26.SH INPUT PARAMETERS
27.ft R
28.TP 1i
29filename
30Name of file to delete (string).
31.TP 1i
32info
33Info object (handle).
34
35.SH OUTPUT PARAMETER
36.ft R
37.TP 1i
38IERROR
39Fortran only: Error status (integer).
40
41.SH DESCRIPTION
42.ft R
43MPI_File_delete deletes the file identified by the file name
44\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.
45.sp
46
47.SH ERRORS
48Almost 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.
49.sp
50Before the error value is returned, the current MPI error handler is
51called. 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. 
52
53
Note: See TracBrowser for help on using the repository browser.