Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 1.7 KB

MPI_File_seek.3.rst

File metadata and controls

83 lines (53 loc) · 1.7 KB
Raw

MPI_File_seek

:ref:`MPI_File_seek` - Updates individual file pointers (noncollective).

SYNTAX

C Syntax

#include <mpi.h>

int MPI_File_seek(MPI_File fh, MPI_Offset offset,
     int whence)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_SEEK(FH, OFFSET, WHENCE, IERROR)
     INTEGER FH, WHENCE, IERROR
     INTEGER(KIND=MPI_OFFSET_KIND)   OFFSET

Fortran 2008 Syntax

USE mpi_f08
MPI_File_seek(fh, offset, whence, ierror)
     TYPE(MPI_File), INTENT(IN) :: fh
     INTEGER(KIND=MPI_OFFSET_KIND), INTENT(IN) :: offset
     INTEGER, INTENT(IN) :: whence
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETERS

  • fh: File handle (handle).
  • offset: File offset (integer).
  • whence: Update mode (integer).

OUTPUT PARAMETER

  • ierror: Fortran only: Error status (integer).

DESCRIPTION

:ref:`MPI_File_seek` updates the individual file pointer according to whence, which could have the following possible values:

  • MPI_SEEK_SET - The pointer is set to offset.
  • MPI_SEEK_CUR - The pointer is set to the current pointer position plus offset.
  • MPI_SEEK_END - The pointer is set to the end of the file plus offset.

The offset can be negative, which allows seeking backwards. It is erroneous to seek to a negative position in the file. The end of the file is defined to be the location of the next elementary data item immediately after the last accessed data item, even if that location is a hole.

ERRORS