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

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

Adding compiled files

File size: 2.7 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_File_write_all 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_File_write_all\fP \- Writes a file starting at the locations specified by individual file pointers (blocking, collective).
6
7.SH SYNTAX
8.ft R
9.nf
10C Syntax
11    #include <mpi.h>
12    int MPI_File_write_all(MPI_File \fIfh\fP, void \fI*buf\fP,
13              int \fIcount\fP, MPI_Datatype \fIdatatype\fP, MPI_Status \fI*status\fP)
14
15Fortran Syntax
16    INCLUDE 'mpif.h'
17    MPI_FILE_WRITE_ALL(\fIFH\fP, \fI BUF\fP, \fICOUNT\fP,
18              \fI DATATYPE\fP, \fISTATUS\fP, \fI IERROR\fP)
19         <type>         BUF(*)
20         INTEGER        FH, COUNT, DATATYPE, STATUS(MPI_STATUS_SIZE),
21                        IERROR
22
23.SH C++ Syntax
24.nf
25#include <mpi.h>
26void MPI::File::Write_all(const void* \fIbuf\fP, int \fIcount\fP,
27        const MPI::Datatype& \fIdatatype\fP, MPI::Status& \fIstatus\fP)
28
29void MPI::File::Write_all(const void* \fIbuf\fP, int \fIcount\fP,
30        const MPI::Datatype& \fIdatatype\fP)
31
32.SH INPUT PARAMETERS
33.ft R
34.TP 1i
35fh
36File handle (handle).
37.TP 1i
38buf
39Initial address of buffer (choice).
40.TP 1i
41count
42Number of elements in buffer (integer).
43.TP 1i
44datatype
45Data type of each buffer element (handle).
46
47.SH OUTPUT PARAMETERS
48.ft R
49.TP 1i
50status
51Status object (status).
52.TP 1i
53IERROR
54Fortran only: Error status (integer).
55
56.SH DESCRIPTION
57.ft R
58MPI_File_write_all is a collective routine that attempts to write into the file associated with
59.I fh
60(at the current individual file pointer position maintained by the system) a total number of
61.I count
62data items having
63.I datatype
64type from the user's buffer
65.I buf.
66The data is written into those parts of the
67file specified by the current view. MPI_File_write_all stores the
68number of
69.I datatype
70elements actually written in
71.I status.
72All other fields of
73.I status
74are undefined.
75.sp
76It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was specified when the file was opened.
77
78.SH ERRORS
79Almost 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.
80.sp
81Before the error value is returned, the current MPI error handler is
82called. 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. 
83
Note: See TracBrowser for help on using the repository browser.