errorutilmodule Module Reference

Data Types
interface	pstop_iface

Functions/Subroutines
subroutine	pstop (status, message)
	Stop the program, optionally specifying an error status code. More...

Variables
procedure(pstop_iface), pointer	pstop_alternative => null()

Function/Subroutine Documentation

pstop()

subroutine errorutilmodule::pstop	(	integer(i4b), intent(in), optional	status,
		character(len=*), intent(in), optional	message
	)

If a non-zero status is specified, the program is terminated with the error status code. If no status is specified or status=0, the program stops with code 0. A message may be provided to print before exiting, useful e.g. for "contact developer" messages upon programming errors.

Parameters

[in]	status	optional error code to return (default=0)
[in]	message	optional message to print before stopping

Definition at line 23 of file ErrorUtil.f90.

    integer(I4B), intent(in), optional :: status !< optional error code to return (default=0)
    character(len=*), intent(in), optional :: message !< optional message to print before stopping
 
    if (associated(pstop_alternative)) then
      if (present(message)) print *, message
      if (present(status)) then
        call pstop_alternative(status)
      else
        call pstop_alternative(0)
      end if
    end if
 
    if (present(message)) print *, message
    if (present(status)) then
      if (status == 0) stop
      call exit(status)
    else
      stop
    end if

Here is the caller graph for this function:

Variable Documentation

pstop_alternative

procedure(pstop_iface), pointer errorutilmodule::pstop_alternative => null()

Definition at line 5 of file ErrorUtil.f90.

  procedure(pstop_iface), pointer :: pstop_alternative => null()