ESMF_ConfigGet Subroutine

public subroutine ESMF_ConfigGet(config, keywordEnforcer, hconfig, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Config), intent(inout) :: config
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_HConfig), intent(out), optional :: hconfig
integer, intent(out), optional :: rc

Source Code

  subroutine ESMF_ConfigGet(config, keywordEnforcer, hconfig, rc)

! !ARGUMENTS:
    type(ESMF_Config),  intent(inout)          :: config
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    type(ESMF_HConfig), intent(out),  optional :: hconfig
    integer,            intent(out),  optional :: rc

!
! !DESCRIPTION: Access Config internals.
!
!   The arguments are:
!   \begin{description}
!   \item [config]
!     Already created {\tt ESMF\_Config} object.
!   \item [{[hconfig]}]
!     Internally kept {\tt ESMF\_HConfig} object.
!   \item [{[rc]}]
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOP --------------------------------------------------------------------------
    integer               :: localrc        ! local return code

    ! initialize return code; assume routine not implemented
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    !check variables
    ESMF_INIT_CHECK_DEEP(ESMF_ConfigGetInit,config,rc)

    if (present(hconfig)) then
      hconfig = config%cptr%hconfig
    endif

    if ( present (rc )) rc = ESMF_SUCCESS

  end subroutine ESMF_ConfigGet