Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_file_get_byte_offset(3openmpi) [osx man page]

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 displacement value, or absolute byte posi-
       tion, from the beginning of the file. The absolute byte position 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 Fortran 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++ func-
       tions 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)

Check Out this Related Man Page

MPI_File_get_size(3OpenMPI)											       MPI_File_get_size(3OpenMPI)

NAME

       MPI_File_get_size - Returns the current size of the file.

SYNTAX

       C Syntax
	   #include <mpi.h>
	   int MPI_File_get_size(MPI_File fh, MPI_Offset *size)

       Fortran Syntax (see FORTRAN 77 NOTES)
	   INCLUDE 'mpif.h'
	   MPI_FILE_GET_SIZE(FH, SIZE,	IERROR)
	    INTEGER FH, ERROR
	    INTEGER(KIND=MPI_OFFSET_KIND) SIZE

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

INPUT PARAMETERS

       fh	 File handle (handle).

       size	 Size of the file in bytes (integer).

OUTPUT PARAMETER

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_File_get_size  returns,  in	size  ,  the current size in bytes of the file associated with the file handle fh. Note that the file size
       returned by Solaris may not represent the number of bytes physically allocated for the file in those cases where all  bytes  in	this  file
       have not been written at least once.

FORTRAN 77 NOTES
       The  MPI standard prescribes portable Fortran syntax for the SIZE argument only for Fortran 90. Sun FORTRAN 77 users may use the non-porta-
       ble syntax

	    INTEGER*MPI_OFFSET_KIND SIZE

       where MPI_ADDRESS_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++ func-
       tions  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.

SEE ALSO

       MPI_File_preallocate

Open MPI 1.2							  September 2006				       MPI_File_get_size(3OpenMPI)
Man Page