MPI_File_get

MPI_File_get_view

Section: Open MPI (3) Updated: Oct 05, 2010 Local index Up

NAME

MPI_File_get_view - Returns the process's view of data in the file.

SYNTAX

C Syntax
    #include <mpi.h>
    int MPI_File_get_view(MPI_File fh, MPI_Offset *disp,
              MPI_Datatype *etype, MPI_Datatype *filetype,
              char *datarep)

Fortran Syntax (see FORTRAN 77 NOTES)
    INCLUDE 'mpif.h'
    MPI_FILE_GET_VIEW(FH, DISP, ETYPE,
               FILETYPE, DATAREP,  IERROR)
         INTEGER FH, ETYPE, FILETYPE, IERROR
         CHARACTER*(*) DATAREP
         INTEGER(KIND=MPI_OFFSET_KIND) DISP

C++ Syntax

#include <mpi.h>
void MPI::File::Get_view(MPI::Offset& disp,
        MPI::Datatype& etype,
        MPI::Datatype& filetype, char* datarep) const

INPUT PARAMETER

fh: File handle (handle).

OUTPUT PARAMETERS

disp: Displacement (integer).
etype: Elementary data type (handle).
filetype: File type (handle). See Restrictions, below.
datarep: Data representation (string).
IERROR: Fortran only: Error status (integer).

DESCRIPTION

The MPI_File_get_view routine returns the process's view of the data in the file. The current values of the displacement, etype, and filetype are returned in disp, etype, and filetype, respectively.

The MPI_File_get_view interface allows the user to pass a data-representation string via the datarep argument.

FORTRAN 77 NOTES

The MPI standard prescribes portable Fortran syntax for the DISP argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax.

     INTEGER*MPI_OFFSET_KIND DISP

where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the length of the declared integer in bytes.

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.

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.

This document was created by man2html, using the manual pages.
Time: 21:50:37 GMT, April 16, 2011