ESMF_AlarmSetInitDeleted Subroutine

public subroutine ESMF_AlarmSetInitDeleted(alarm, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Alarm), intent(inout) :: alarm
integer, intent(out), optional :: rc

Called by

proc~~esmf_alarmsetinitdeleted~~CalledByGraph proc~esmf_alarmsetinitdeleted ESMF_AlarmSetInitDeleted proc~esmf_alarmdestroy ESMF_AlarmDestroy proc~esmf_alarmdestroy->proc~esmf_alarmsetinitdeleted program~esmf_alarmex ESMF_AlarmEx program~esmf_alarmex->proc~esmf_alarmdestroy program~esmf_alarmtest ESMF_AlarmTest program~esmf_alarmtest->proc~esmf_alarmdestroy

Source Code

      subroutine ESMF_AlarmSetInitDeleted(alarm, rc)
!
! !ARGUMENTS:
      type(ESMF_Alarm), intent(inout)         :: alarm
      integer,          intent(out), optional :: rc  
!         
!
! !DESCRIPTION:
!     Set init code in Alarm object to "DELETED".
!
!     The arguments are:
!     \begin{description}
!     \item[alarm] 
!          Specified {\tt ESMF\_Alarm} object.
!     \item[{[rc]}] 
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI
!------------------------------------------------------------------------------

      ! Assume failure until success
      if (present(rc)) rc = ESMF_RC_NOT_IMPL
    
      ! Set init code
      ESMF_INIT_SET_DELETED(alarm)

      ! Return success
      if (present(rc)) rc = ESMF_SUCCESS
    
      end subroutine ESMF_AlarmSetInitDeleted