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

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

Adding compiled files

File size: 2.6 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_File_write_all_begin 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_File_write_all_begin\fP \- Writes a file starting at the locations specified by individual file pointers; beginning part of a split collective routine (nonblocking).
6
7.SH SYNTAX
8.ft R
9.nf
10C Syntax
11    #include <mpi.h>
12    int MPI_File_write_all_begin(MPI_File \fIfh\fP, void \fI*buf\fP,
13              int \fIcount\fP, MPI_Datatype \fIdatatype\fP)
14
15Fortran Syntax
16    INCLUDE 'mpif.h'
17    MPI_FILE_WRITE_ALL_BEGIN(\fIFH\fP, \fIBUF\fP, \fICOUNT\fP, \fIDATATYPE\fP,\fI IERROR\fP)
18                <type>          BUF(*)
19                INTEGER         FH, COUNT, DATATYPE, IERROR
20
21.SH C++ Syntax
22.nf
23#include <mpi.h>
24void MPI::File::Write_all_begin(const void* \fIbuf\fP, int \fIcount\fP,
25        const MPI::Datatype& \fIdatatype\fP)
26
27.SH INPUT/OUTPUT PARAMETER
28.ft R
29.TP 1i
30fh   
31File handle (handle).
32
33.SH INPUT PARAMETERS
34.ft R
35.TP 1i
36buf
37Initial address of buffer (choice).
38.ft R
39.TP 1i
40count
41Number of elements in buffer (integer).
42.ft R
43.TP 1i
44datatype
45Data type of each buffer element (handle).
46
47.SH OUTPUT PARAMETER
48.ft R
49.TP 1i
50IERROR
51Fortran only: Error status (integer).
52
53.SH DESCRIPTION
54.ft R
55MPI_File_write_all_begin is the beginning part of a split collective, nonblocking routine that attempts to write into the file associated with
56.I fh
57(at the current individual file pointer position maintained by the system) a total number of
58.I count
59data items having
60.I datatype
61type from the user's buffer
62.I buf.
63The data is written into those parts of the
64file specified by the current view.
65
66.SH NOTES
67.ft R
68All the nonblocking collective routines for data access are "split" into two routines, each with _begin or _end as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard.
69
70.SH ERRORS
71Almost 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.
72.sp
73Before the error value is returned, the current MPI error handler is
74called. 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. 
75
76
77
78
Note: See TracBrowser for help on using the repository browser.