ESMF_RouteHandleGetI Subroutine

private subroutine ESMF_RouteHandleGetI(routehandle, htype, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_RouteHandle), intent(in) :: routehandle
integer, intent(out) :: htype
integer, intent(out) :: rc

Source Code

  subroutine ESMF_RouteHandleGetI(routehandle, htype, rc)
!
! !ARGUMENTS:
    type(ESMF_RouteHandle), intent(in)  :: routehandle
    integer,                intent(out) :: htype
    integer,                intent(out) :: rc

!
! !DESCRIPTION:
!     Returns information about an {\tt ESMF\_RouteHandle}.
!
!     The arguments are:
!     \begin{description}
!     \item[routehandle]
!          {\tt ESMF\_RouteHandle} to be queried.
!     \item[htype]
!          Route type.
!     \item[rc]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code

    ! initialize return code; assume routine not implemented
    localrc = ESMF_RC_NOT_IMPL
    rc = ESMF_RC_NOT_IMPL

    ESMF_INIT_CHECK_DEEP(ESMF_RouteHandleGetInit,routehandle,rc)

    call c_ESMC_RouteHandleGetType(routehandle, htype, localrc)
    if (ESMF_LogFoundError(localrc, &
      ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! Return successfully
    rc = ESMF_SUCCESS

  end subroutine ESMF_RouteHandleGetI