ESMF_HConfigIterGetInit Function

private function ESMF_HConfigIterGetInit(hconfig)

Arguments

Type IntentOptional Attributes Name
type(ESMF_HConfigIter), intent(in), optional :: hconfig

Return Value integer(kind=ESMF_KIND_I8)


Source Code

  function ESMF_HConfigIterGetInit(hconfig)
!
! !RETURN VALUE:
    ESMF_INIT_TYPE :: ESMF_HConfigIterGetInit
!
! !ARGUMENTS:
    type(ESMF_HConfigIter), intent(in), optional :: hconfig
!
! !DESCRIPTION:
!   Access deep object init code.
!
!   The arguments are:
!   \begin{description}
!   \item [hconfig]
!     HConfig object.
!   \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    if (present(hconfig)) then
      ESMF_HConfigIterGetInit = ESMF_INIT_GET(hconfig)
    else
      ESMF_HConfigIterGetInit = ESMF_INIT_CREATED
    endif

  end function ESMF_HConfigIterGetInit