ESMF_IO_YAMLContentInit Subroutine

public subroutine ESMF_IO_YAMLContentInit(yaml, keywordEnforcer, cflag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_IO_YAML) :: yaml
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_IO_YAMLContent_Flag), intent(in), optional :: cflag
integer, intent(out), optional :: rc

Source Code

  subroutine ESMF_IO_YAMLContentInit(yaml, keywordEnforcer, cflag, &
    rc)
!
! !ARGUMENTS:
    type(ESMF_IO_YAML)                                  :: yaml
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    type(ESMF_IO_YAMLContent_Flag), intent(in), optional :: cflag
    integer,                      intent(out), optional :: rc

! !DESCRIPTION:
!     Create content from parsed YAML in a {\tt ESMF\_YAML\_IO} object.
!
!     The arguments are:
!     \begin{description}
!     \item[{yaml}]
!          Output parsed contents of this {\tt ESMF\_IO_YAML} object.
!     \item[{cflag}]
!          Return parsed content in {\tt ESMF_IO_YAMLContent_Flag} format
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI

    ! local return code
    integer :: localrc
    type(ESMF_IO_YAMLContent_Flag) :: localcflag
!
!   ! Assume failure until success
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    localcflag = ESMF_IOYAML_CONTENT_UNSET
    if (present(cflag)) localcflag = cflag

    call c_ESMC_IO_YAMLCInit(yaml, localcflag, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! Return success
    if (present(rc)) rc = ESMF_SUCCESS

  end subroutine ESMF_IO_YAMLContentInit