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

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

Adding compiled files

File size: 2.4 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_File_read_at_all_end 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_File_read_at_all_end\fP \- Reads a file at explicitly specified offsets; ending part of a split collective routine (blocking).
6
7.SH SYNTAX
8.ft R
9.nf
10C Syntax
11    #include <mpi.h>
12    int MPI_File_read_at_all_end(MPI_File \fIfh\fP, void \fI*buf\fP,
13        MPI_Status \fI*status\fP)
14
15Fortran Syntax
16    INCLUDE 'mpif.h'
17    MPI_FILE_READ_AT_ALL_END(\fIFH\fP, \fIBUF\fP, \fISTATUS\fP,\fI IERROR\fP)
18                <TYPE>          BUF(*)
19                INTEGER         FH, STATUS(MPI_STATUS_SIZE), IERROR
20
21.SH C++ Syntax
22.nf
23#include <mpi.h>
24void MPI::File::Read_at_all_end(void* \fIbuf\fP, MPI::Status& \fIstatus\fP)
25
26void MPI::File::Read_at_all_end(void* \fIbuf\fP)
27
28.SH INPUT PARAMETER
29.ft R
30.TP 1i
31fh   
32File handle (handle).
33
34.SH OUTPUT PARAMETERS
35.ft R
36.TP 1i
37buf
38Initial address of buffer (choice).
39.ft R
40.TP 1i
41status
42Status object (status).
43.TP 1i
44IERROR
45Fortran only: Error status (integer).
46
47.SH DESCRIPTION
48.ft R
49MPI_File_read_at_all_end is a split collective routine that stores the number of elements actually read from the file associated with
50.I fh
51in
52.I status.
53MPI_File_read_at_all_end blocks until the operation initiated by MPI_File_read_at_all_begin completes. The data is taken out of those parts of the file specified by the current view. All other fields of
54.I status
55are undefined.
56
57.SH NOTES
58.ft R
59All 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.
60
61.SH ERRORS
62Almost 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.
63.sp
64Before the error value is returned, the current MPI error handler is
65called. 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. 
66
Note: See TracBrowser for help on using the repository browser.