ESMF_IO_YAMLCreate Function

public function ESMF_IO_YAMLCreate(keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Return Value type(ESMF_IO_YAML)


Source Code

  function ESMF_IO_YAMLCreate(keywordEnforcer, rc)
!
! !RETURN VALUE:
    type(ESMF_IO_YAML) :: ESMF_IO_YAMLCreate

! !ARGUMENTS:
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer ! must use keywords below
    integer,                intent(out), optional :: rc

! !DESCRIPTION:
!     Creates a new {\tt ESMF\_YAML\_IO} object.    
!
!     The arguments are:
!     \begin{description}
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!     
!EOPI

    ! local return code
    integer :: localrc

!   ! Assume failure until success
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

!   invoke C to C++ entry point to allocate and initialize new IO_YAML object
    call c_ESMC_IO_YAMLCreate(ESMF_IO_YAMLCreate, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
         ESMF_CONTEXT, rcToReturn=rc)) return

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

  end function ESMF_IO_YAMLCreate