MPI_File_get_size(3)               Open MPI               MPI_File_get_size(3)



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-
       portable 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++
       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.


SEE ALSO
       MPI_File_preallocate




1.4.1                            Jan 14, 2010             MPI_File_get_size(3)
