72 строки
2.3 KiB
Groff
72 строки
2.3 KiB
Groff
.\"Copyright 2006, Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.
|
|
.\" Copyright (c) 1996 Thinking Machines Corporation
|
|
.TH MPI_File_read_shared 3OpenMPI "September 2006" "Open MPI 1.2" " "
|
|
.SH NAME
|
|
\fBMPI_File_read_shared\fP \- Reads a file using the shared file pointer (blocking, noncollective).
|
|
|
|
.SH SYNTAX
|
|
.ft R
|
|
.nf
|
|
C Syntax
|
|
#include <mpi.h>
|
|
int MPI_File_read_shared(MPI_File \fIfh\fP, void \fI*buf\fP, int \fIcount\fP,
|
|
MPI_Datatype \fIdatatype\fP, MPI_Status \fI*status\fP)
|
|
|
|
Fortran Syntax
|
|
INCLUDE 'mpif.h'
|
|
MPI_FILE_READ_SHARED(\fIFH\fP, \fIBUF\fP, \fICOUNT\fP, \fIDATATYPE\fP, \fISTATUS\fP,
|
|
\fIIERROR\fP)
|
|
<TYPE> BUF(*)
|
|
INTEGER FH, COUNT, DATATYPE,
|
|
STATUS(MPI_STATUS_SIZE), IERROR
|
|
|
|
.SH C++ Syntax
|
|
.nf
|
|
#include <mpi.h>
|
|
void MPI::File::Read_shared(void* \fIbuf\fP, int \fIcount\fP,
|
|
const MPI::Datatype& \fIdatatype\fP, MPI::Status& \fIstatus\fP)
|
|
|
|
void MPI::File::Read_shared(void* \fIbuf\fP, int \fIcount\fP,
|
|
const MPI::Datatype& \fIdatatype\fP)
|
|
|
|
.SH INPUT/OUTPUT PARAMETER
|
|
.ft R
|
|
.TP 1i
|
|
fh
|
|
File handle (handle).
|
|
|
|
.SH INPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
count
|
|
Number of elements in buffer (integer)
|
|
.ft R
|
|
.TP 1i
|
|
datatype
|
|
Data type of each buffer element (handle).
|
|
|
|
.SH OUTPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
buf
|
|
Initial address of buffer (choice).
|
|
.ft R
|
|
.TP 1i
|
|
status
|
|
Status object (status).
|
|
.TP 1i
|
|
IERROR
|
|
Fortran only: Error status (integer).
|
|
|
|
.SH DESCRIPTION
|
|
.ft R
|
|
MPI_File_read_shared is a blocking routine that uses the shared file pointer to read files. The order of serialization is not deterministic for this noncollective routine.
|
|
|
|
.SH ERRORS
|
|
Almost 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.
|
|
.sp
|
|
Before the error value is returned, the current MPI error handler is
|
|
called. 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.
|
|
|
|
' @(#)MPI_File_read_shared.3 1.20 06/03/09
|