Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_HConfig), | intent(in) | :: | hconfig | |||
character(len=*), | intent(in) | :: | filename | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
integer, | intent(in), | optional | :: | doc | ||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_HConfigFileSave(hconfig, filename, keywordEnforcer, doc, rc) ! ! !ARGUMENTS: type(ESMF_HConfig), intent(in) :: hconfig character(len=*), intent(in) :: filename type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below integer, intent(in), optional :: doc integer, intent(out), optional :: rc ! ! !DESCRIPTION: ! Save HConfig into YAML file. Only {\tt localPet == 0} does the writing. ! The {\tt hconfig} must {\em not} be a map iterator. ! ! The arguments are: ! \begin{description} ! \item[hconfig] ! {\tt ESMF\_HConfig} object. ! \item[filename] ! Name of the YAML file into which to save. ! \item[{[doc]}] ! The doc index inside {\tt hconfig}. 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 ! 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) ! Call into the C++ interface, which will sort out optional arguments. call c_ESMC_HConfigFileSave(hconfig, filename, 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_HConfigFileSave