ESMF_InfoDestroy Subroutine

public subroutine ESMF_InfoDestroy(info, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Info), intent(inout) :: info
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Calls

proc~~esmf_infodestroy~~CallsGraph proc~esmf_infodestroy ESMF_InfoDestroy interface~c_info_destroy c_info_destroy proc~esmf_infodestroy->interface~c_info_destroy proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_infodestroy->proc~esmf_logfounderror 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

ESMF_AttributeAddAttPackStdInfowESMF_InfoDestroy
w
ESMF_AttributeReadArrayw
w
ESMF_AttributeReadArrayBundlew
w
ESMF_AttributeReadCplCompw
w
ESMF_AttributeReadDistGridw
w
ESMF_AttributeReadFieldw
w
ESMF_AttributeReadFieldBundlew
w
ESMF_AttributeReadGridw
w
ESMF_AttributeReadGridCompw
w
ESMF_AttributeReadLocStreamw
w
ESMF_AttributeReadMeshw
w
ESMF_AttributeReadSciCompw
w
ESMF_AttributeReadStatew
w
ESMF_AttributeWriteArrayw
w
ESMF_AttributeWriteArrayBundlew
w
ESMF_AttributeWriteCplCompw
w
ESMF_AttributeWriteDistGridw
w
ESMF_AttributeWriteFieldw
w
ESMF_AttributeWriteFieldBundlew
w
ESMF_AttributeWriteGridw
w
ESMF_AttributeWriteGridCompw
w
ESMF_AttributeWriteLocStreamw
w
ESMF_AttributeWriteMeshw
w
ESMF_AttributeWriteSciCompw
w
ESMF_AttributeWriteStatew
w
ESMF_InfoArrayUTestw
w
ESMF_InfoDescribe%ESMF_InfoDescribeDestroyw
w
ESMF_InfoInquirew
w
ESMF_InfoSetHConfigw
w
ESMF_InfoSyncUTestw
w
ESMF_InfoTutorialw
w
ESMF_InfoUTestw
w

Source Code

subroutine ESMF_InfoDestroy(info, keywordEnforcer, rc)
! !ARGUMENTS:
  type(ESMF_Info), intent(inout) :: info
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
  integer, intent(out), optional :: rc
!
! !DESCRIPTION:
!     Destroy an \texttt{ESMF\_Info} object. Destroying an \texttt{ESMF\_Info}
!     object created internally by an ESMF object results in an error
!
!     The arguments are:
!     \begin{description}
!     \item [info]
!       Target \texttt{ESMF\_Info} object.
!     \item [{[rc]}]
!       Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!EOP

  integer :: localrc

  localrc = ESMF_FAILURE
  if (present(rc)) rc = ESMF_FAILURE

  if (info%is_view) then
    if (ESMF_LogFoundError(localrc, msg="Object is a view and may not be destroyed. Destroy its host object.", &
      ESMF_CONTEXT, rcToReturn=rc)) return
  endif

  call c_info_destroy(info%ptr, localrc)
  info%ptr = C_NULL_PTR
  if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, ESMF_CONTEXT, rcToReturn=rc)) return

  if (present(rc)) rc = ESMF_SUCCESS
end subroutine ESMF_InfoDestroy