ESMF_HConfigLog Subroutine

public subroutine ESMF_HConfigLog(hconfig, keywordEnforcer, prefix, logMsgFlag, doc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_HConfig), intent(in) :: hconfig
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(in), optional :: prefix
type(ESMF_LogMsg_Flag), intent(in), optional :: logMsgFlag
integer, intent(in), optional :: doc
integer, intent(out), optional :: rc

Calls

proc~~esmf_hconfiglog~~CallsGraph proc~esmf_hconfiglog ESMF_HConfigLog c_esmc_hconfiglog c_esmc_hconfiglog proc~esmf_hconfiglog->c_esmc_hconfiglog proc~esmf_hconfiggetinit ESMF_HConfigGetInit proc~esmf_hconfiglog->proc~esmf_hconfiggetinit proc~esmf_imerr ESMF_IMErr proc~esmf_hconfiglog->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_hconfiglog->proc~esmf_logfounderror proc~esmf_imerr->proc~esmf_logfounderror proc~esmf_initcheckdeep ESMF_InitCheckDeep proc~esmf_imerr->proc~esmf_initcheckdeep esmf_breakpoint esmf_breakpoint proc~esmf_logfounderror->esmf_breakpoint proc~esmf_logrc2msg ESMF_LogRc2Msg proc~esmf_logfounderror->proc~esmf_logrc2msg proc~esmf_logwrite ESMF_LogWrite proc~esmf_logfounderror->proc~esmf_logwrite c_esmc_loggeterrormsg c_esmc_loggeterrormsg proc~esmf_logrc2msg->c_esmc_loggeterrormsg c_esmc_vmwtime c_esmc_vmwtime proc~esmf_logwrite->c_esmc_vmwtime proc~esmf_logclose ESMF_LogClose proc~esmf_logwrite->proc~esmf_logclose proc~esmf_logflush ESMF_LogFlush proc~esmf_logwrite->proc~esmf_logflush proc~esmf_logopenfile ESMF_LogOpenFile proc~esmf_logwrite->proc~esmf_logopenfile proc~esmf_utiliounitflush ESMF_UtilIOUnitFlush proc~esmf_logwrite->proc~esmf_utiliounitflush proc~esmf_utilstring2array ESMF_UtilString2Array proc~esmf_logwrite->proc~esmf_utilstring2array proc~esmf_logclose->proc~esmf_logflush proc~esmf_logflush->proc~esmf_utiliounitflush proc~esmf_utilarray2string ESMF_UtilArray2String proc~esmf_logflush->proc~esmf_utilarray2string proc~esmf_logopenfile->proc~esmf_utiliounitflush proc~esmf_utiliounitget ESMF_UtilIOUnitGet proc~esmf_logopenfile->proc~esmf_utiliounitget

Called by

proc~~esmf_hconfiglog~~CalledByGraph proc~esmf_hconfiglog ESMF_HConfigLog program~esmf_hconfigex ESMF_HConfigEx program~esmf_hconfigex->proc~esmf_hconfiglog program~esmf_hconfigutest ESMF_HConfigUTest program~esmf_hconfigutest->proc~esmf_hconfiglog

Source Code

  subroutine ESMF_HConfigLog(hconfig, keywordEnforcer, prefix, logMsgFlag, doc, rc)
!
! !ARGUMENTS:
    type(ESMF_HConfig),     intent(in)            :: hconfig
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    character(len=*),       intent(in),  optional :: prefix
    type(ESMF_LogMsg_Flag), intent(in),  optional :: logMsgFlag
    integer,                intent(in),  optional :: doc
    integer,                intent(out), optional :: rc
!
! !DESCRIPTION:
!   Write the contents of {\tt hconfig} to the ESMF default Log.
!
!   The arguments are:
!   \begin{description}
!   \item[hconfig]
!     {\tt ESMF\_HConfig} object written to log.
!   \item [{[prefix]}]
!     String to prefix the log message. Default is no prefix.
!   \item [{[logMsgFlag]}]
!     Type of log message generated. See section \ref{const:logmsgflag} for
!     a list of valid message types. Default is {\tt ESMF\_LOGMSG\_INFO}.
!   \item[{[doc]}]
!     The doc index. If specified, only content of the indicated
!     single document is written to log. Defaults to {\em all} docs.
!   \item[{[rc]}]
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code
    type(ESMF_LogMsg_Flag)  :: logMsg

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

    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP(ESMF_HConfigGetInit, hconfig, rc)

    ! deal with optionl logMsgFlag
    logMsg = ESMF_LOGMSG_INFO ! default
    if (present(logMsgFlag)) logMsg = logMsgFlag

    ! Call into the C++ interface.
    call c_esmc_hconfiglog(hconfig, prefix, logMsg, doc, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! return successfully
    if (present(rc)) rc = ESMF_SUCCESS

  end subroutine ESMF_HConfigLog