This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

MPI_File_get_byte_offset(3OpenMPI)                                        MPI_File_get_byte_offset(3OpenMPI)



NAME
       MPI_File_get_byte_offset - Converts a view-relative offset into an absolute byte position.


SYNTAX
       C Syntax
           #include <mpi.h>
           int MPI_File_get_byte_offset(MPI_File fh, MPI_Offset offset,
                  MPI_Offset *disp)

       Fortran Syntax (see FORTRAN 77 NOTES)
           INCLUDE 'mpif.h'
           MPI_FILE_GET_BYTE_OFFSET(FH, OFFSET, DISP, IERROR)
                 INTEGER   FH, IERROR
                 INTEGER(KIND=MPI_OFFSET_KIND) OFFSET, DISP


C++ Syntax
       #include <mpi.h>
       MPI::Offset MPI::File::Get_byte_offset(const MPI::Offset disp)
            const


INPUT PARAMETERS
       fh        File handle (handle).

       offset    Offset (integer).


OUTPUT PARAMETERS
       disp      Absolute byte position of offset (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPI_File_get_byte_offset  converts an offset specified for the current view to its corresponding dis-placement displacement
       placement value, or absolute byte position, from the beginning of the file. The absolute  byte  posi-tion position
       tion of offset relative to the current view of fh is returned in disp.


FORTRAN 77 NOTES
       The  MPI  standard prescribes portable Fortran syntax for the OFFSET and DISP arguments only for For-tran Fortran
       tran 90. Sun FORTRAN 77 users may use the non-portable syntax

            INTEGER*MPI_OFFSET_KIND OFFSET
       or
            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.





Open MPI 1.2                                   September 2006             MPI_File_get_byte_offset(3OpenMPI)