Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_Container), | intent(inout) | :: | container | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_ContainerClear(container, keywordEnforcer, rc) ! ! !ARGUMENTS: type(ESMF_Container), intent(inout) :: container type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below integer, intent(out), optional :: rc ! ! !DESCRIPTION: ! Clear an {\tt ESMF\_Container} object, i.e. remove all items. ! ! This method defines garbage as all the elements in the {\tt container}. ! ! The arguments are: ! \begin{description} ! \item[container] ! {\tt ESMF\_Container} object to be cleared. ! \item[{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} ! !EOPI !------------------------------------------------------------------------------ integer :: localrc ! local return code ! Initialize return code; assume failure until success is certain localrc = ESMF_RC_NOT_IMPL if (present(rc)) rc = ESMF_RC_NOT_IMPL ! Check init status of arguments ESMF_INIT_CHECK_DEEP_SHORT(ESMF_ContainerGetInit, container, rc) ! Call into the C++ interface layer call c_ESMC_ContainerClear(container, localrc) if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, & ESMF_CONTEXT, rcToReturn=rc)) return ! Return successfully if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_ContainerClear