SCORPIO  1.7.0
Functions/Subroutines
PIO_seterrorhandling

Set the error handler to use for an I/O system of file. More...

Functions/Subroutines

subroutine spio_err::pio_seterrorhandling_iosysid (iosysid, eh, old_eh, ierr)
 Set the error handler to use for an I/O system. More...
 
subroutine spio_err::pio_seterrorhandling_iosys (iosys, eh, old_eh, ierr)
 Set the error handler to use for an I/O system. More...
 
subroutine spio_err::pio_seterrorhandling_file (file, eh, old_eh, ierr)
 Set the error handler to use for a file. More...
 

Detailed Description

Set the error handler to use for an I/O system of file.

The four types of error handling methods are:

Use this instead of ios to set error handling for the library.

Function/Subroutine Documentation

◆ pio_seterrorhandling_file()

subroutine spio_err::pio_seterrorhandling_file ( type(file_desc_t), intent(in)  file,
integer, intent(in)  eh,
integer, intent(out), optional  old_eh,
integer, intent(out), optional  ierr 
)

Set the error handler to use for a file.

Set the error handler to use for a file. Note that setting the error handler for a file also sets the error handler for the I/O system associated with the file

Parameters
[in]fileThe file to set the error handler

File descriptor structure. This structure holds information associated with each open file

Parameters
[in]ehThe error handler method to use for this file & I/O subsystem.

The four types of error handling methods are:

  • PIO_INTERNAL_ERROR : abort on error from any task
  • PIO_BCAST_ERROR : broadcast an error from io_rank 0 to all tasks in comm
  • PIO_REDUCE_ERROR : Reduce error across all tasks in comm
  • PIO_RETURN_ERROR : do nothing - allow the user to handle it

Use this instead of ios to set error handling for the library.

Parameters
[out]old_eh(Optional) The old error handler method used by the I/O subsystem associated with this file
[out]ierr(Optional) : The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_seterrorhandling_iosys()

subroutine spio_err::pio_seterrorhandling_iosys ( type(iosystem_desc_t), intent(in)  iosys,
integer, intent(in)  eh,
integer, intent(out), optional  old_eh,
integer, intent(out), optional  ierr 
)

Set the error handler to use for an I/O system.

Parameters
[in]iosysThe I/O subsystem where the error handler needs to be set

IO system descriptor structure. This structure contains the general IO subsystem data and MPI structure

Parameters
[in]ehThe error handler method to use for this I/O subsystem.

The four types of error handling methods are:

  • PIO_INTERNAL_ERROR : abort on error from any task
  • PIO_BCAST_ERROR : broadcast an error from io_rank 0 to all tasks in comm
  • PIO_REDUCE_ERROR : Reduce error across all tasks in comm
  • PIO_RETURN_ERROR : do nothing - allow the user to handle it

Use this instead of ios to set error handling for the library.

Parameters
[out]old_eh(Optional) The old error handler method used by the I/O subsystem.
[out]ierr(Optional) : The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_seterrorhandling_iosysid()

subroutine spio_err::pio_seterrorhandling_iosysid ( integer, intent(in)  iosysid,
integer, intent(in)  eh,
integer, intent(out), optional  old_eh,
integer, intent(out), optional  ierr 
)

Set the error handler to use for an I/O system.

Parameters
[in]iosysidThe id/handle of the I/O subsystem where the error handler needs to be set. IO system descriptor structure. This structure contains the general IO subsystem data and MPI structure
[in]ehThe error handler method to use for this I/O subsystem.

The four types of error handling methods are:

  • PIO_INTERNAL_ERROR : abort on error from any task
  • PIO_BCAST_ERROR : broadcast an error from io_rank 0 to all tasks in comm
  • PIO_REDUCE_ERROR : Reduce error across all tasks in comm
  • PIO_RETURN_ERROR : do nothing - allow the user to handle it

Use this instead of ios to set error handling for the library.

Parameters
[out]old_eh(Optional) The old error handler method used by the I/O subsystem.
[out]ierr(Optional) : The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)