Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_Alarm), | intent(inout) | :: | alarm | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_AlarmDestroy(alarm, keywordEnforcer, rc) ! ! !ARGUMENTS: type(ESMF_Alarm), intent(inout) :: alarm type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below integer, intent(out), optional :: rc ! ! ! !STATUS: ! \begin{itemize} ! \item\apiStatusCompatibleVersion{5.2.0r} ! \end{itemize} ! ! !DESCRIPTION: ! \begin{sloppypar} ! Releases resources associated with this {\tt ESMF\_Alarm}. Also ! removes this {\tt ESMF\_Alarm} from its associated {\tt ESMF\_Clock}'s ! list of {\tt ESMF\_Alarm}s (removes the {\tt ESMF\_Alarm} pointer from ! the list). ! \end{sloppypar} ! ! The arguments are: ! \begin{description} ! \item[alarm] ! Release resources associated with this {\tt ESMF\_Alarm} and mark the ! object as invalid. It is an error to pass this object into any other ! routines after being destroyed. ! \item[[rc]] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} ! !EOP ! !REQUIREMENTS: integer :: localrc ! local return code ! Assume failure until success if (present(rc)) rc = ESMF_RC_NOT_IMPL localrc = ESMF_RC_NOT_IMPL ! check input ESMF_INIT_CHECK_DEEP(ESMF_AlarmGetInit,alarm,rc) ! invoke C to C++ entry point call c_ESMC_AlarmDestroy(alarm, localrc) if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, & ESMF_CONTEXT, rcToReturn=rc)) return ! mark output as successfully deleted call ESMF_AlarmSetInitDeleted(alarm) if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_AlarmDestroy