Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 2.07 KB

MPI_File_seek_shared.3.rst

File metadata and controls

90 lines (59 loc) · 2.07 KB
Raw

MPI_File_seek_shared

:ref:`MPI_File_seek_shared` |mdash| Updates the global shared file pointer (collective).

SYNTAX

C Syntax

#include <mpi.h>

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

Fortran Syntax

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

Fortran 2008 Syntax

USE mpi_f08
MPI_File_seek_shared(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_shared` updates the shared 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.

:ref:`MPI_File_seek_shared` is collective; all the processes in the communicator group associated with the file handle fh must call :ref:`MPI_File_seek_shared` with the same offset and whence. All processes in the communicator group are synchronized before the shared file pointer is updated.

The offset can be negative, which allows seeking backwards. It is erroneous to seek to a negative position in the view. The end of the view is defined to be the position of the next elementary data item, relative to the current view, following the last whole elementary data item accessible.

ERRORS